hendrik/lens
1
0
Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity
54eaac9422
lens/master/extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/index.html

1144 lines
42 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Documentation for Lens Extension Development and API.">
<meta name="author" content="Mirantis, Inc.">
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/">
<link rel="icon" href="../../../../img/favicon.ico">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.12">
<title>Main.K8sApi.BaseKubeJsonApiObjectMetadata - Lens Extension Development</title>
<link rel="stylesheet" href="../../../../assets/stylesheets/main.85bb2934.min.css">
<link rel="stylesheet" href="../../../../assets/stylesheets/palette.a6bdf11c.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../../../stylesheets/extra.css">
<script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script id="__analytics">function __md_analytics(){window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-159377374-2","auto"),ga("set","anonymizeIp",!0),ga("send","pageview"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){var e;this.value&&(e=document.location.pathname,ga("send","pageview",e+"?q="+this.value))}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");ga("send","event","feedback","click",t,e),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){ga("send","pageview",e.pathname)})});var e=document.createElement("script");e.async=!0,e.src="https://www.google-analytics.com/analytics.js",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
<script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo">
<script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#interface-basekubejsonapiobjectmetadatanamespaced" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../../../.." title="Lens Extension Development" class="md-header__button md-logo" aria-label="Lens Extension Development" data-md-component="logo">
<img src="../../../../img/lens-logo-icon.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Lens Extension Development
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Main.K8sApi.BaseKubeJsonApiObjectMetadata
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6zm0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4zM7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z"/></svg>
</label>
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3Z"/></svg>
</label>
</form>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/lensapp/lens" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../../../.." title="Lens Extension Development" class="md-nav__button md-logo" aria-label="Lens Extension Development" data-md-component="logo">
<img src="../../../../img/lens-logo-icon.svg" alt="logo">
</a>
Lens Extension Development
</label>
<div class="md-nav__source">
<a href="https://github.com/lensapp/lens" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../.." class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../get-started/overview/" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../../../get-started/your-first-extension/" class="md-nav__link">
Your First Extension
</a>
</li>
<li class="md-nav__item">
<a href="../../../get-started/anatomy/" class="md-nav__link">
Extension Anatomy
</a>
</li>
<li class="md-nav__item">
<a href="../../../get-started/wrapping-up/" class="md-nav__link">
Wrapping Up
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
Extension Capabilities
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Extension Capabilities
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../capabilities/common-capabilities/" class="md-nav__link">
Common Capabilities
</a>
</li>
<li class="md-nav__item">
<a href="../../../capabilities/styling/" class="md-nav__link">
Styling
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
Extension Guides
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Extension Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../guides/" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/generator/" class="md-nav__link">
Generator
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/main-extension/" class="md-nav__link">
Main Extension
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/renderer-extension/" class="md-nav__link">
Renderer Extension
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/catalog/" class="md-nav__link">
Catalog
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/resource-stack/" class="md-nav__link">
Resource Stack
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/extending-kubernetes-cluster/" class="md-nav__link">
Extending KubernetesCluster
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/stores/" class="md-nav__link">
Stores
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/working-with-mobx/" class="md-nav__link">
Working with MobX
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/protocol-handlers/" class="md-nav__link">
Protocol Handlers
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/ipc/" class="md-nav__link">
IPC
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
Testing and Publishing
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Testing and Publishing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../testing-and-publishing/testing/" class="md-nav__link">
Testing Extensions
</a>
</li>
<li class="md-nav__item">
<a href="../../../testing-and-publishing/publishing/" class="md-nav__link">
Publishing Extensions
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../" class="md-nav__link">
API Reference
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#type-parameters" class="md-nav__link">
Type parameters
</a>
</li>
<li class="md-nav__item">
<a href="#indexable" class="md-nav__link">
Indexable
</a>
</li>
<li class="md-nav__item">
<a href="#table-of-contents" class="md-nav__link">
Table of contents
</a>
<nav class="md-nav" aria-label="Table of contents">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#properties" class="md-nav__link">
Properties
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#properties_1" class="md-nav__link">
Properties
</a>
<nav class="md-nav" aria-label="Properties">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#annotations" class="md-nav__link">
annotations
</a>
</li>
<li class="md-nav__item">
<a href="#clustername" class="md-nav__link">
clusterName
</a>
</li>
<li class="md-nav__item">
<a href="#creationtimestamp" class="md-nav__link">
creationTimestamp
</a>
</li>
<li class="md-nav__item">
<a href="#deletiongraceperiodseconds" class="md-nav__link">
deletionGracePeriodSeconds
</a>
</li>
<li class="md-nav__item">
<a href="#deletiontimestamp" class="md-nav__link">
deletionTimestamp
</a>
</li>
<li class="md-nav__item">
<a href="#finalizers" class="md-nav__link">
finalizers
</a>
</li>
<li class="md-nav__item">
<a href="#generatename" class="md-nav__link">
generateName
</a>
</li>
<li class="md-nav__item">
<a href="#generation" class="md-nav__link">
generation
</a>
</li>
<li class="md-nav__item">
<a href="#labels" class="md-nav__link">
labels
</a>
</li>
<li class="md-nav__item">
<a href="#managedfields" class="md-nav__link">
managedFields
</a>
</li>
<li class="md-nav__item">
<a href="#name" class="md-nav__link">
name
</a>
</li>
<li class="md-nav__item">
<a href="#namespace" class="md-nav__link">
namespace
</a>
</li>
<li class="md-nav__item">
<a href="#ownerreferences" class="md-nav__link">
ownerReferences
</a>
</li>
<li class="md-nav__item">
<a href="#resourceversion" class="md-nav__link">
resourceVersion
</a>
</li>
<li class="md-nav__item">
<a href="#selflink" class="md-nav__link">
selfLink
</a>
</li>
<li class="md-nav__item">
<a href="#uid" class="md-nav__link">
uid
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<p><a href="../../">@k8slens/extensions</a> / <a href="../../modules/">Exports</a> / <a href="../../modules/Main/">Main</a> / <a href="../../modules/Main.K8sApi/">K8sApi</a> / BaseKubeJsonApiObjectMetadata</p>
<h1 id="interface-basekubejsonapiobjectmetadatanamespaced">Interface: BaseKubeJsonApiObjectMetadata&lt;Namespaced><a class="headerlink" href="#interface-basekubejsonapiobjectmetadatanamespaced" title="Permanent link">#</a></h1>
<p><a href="../../modules/Main/">Main</a>.<a href="../../modules/Main.K8sApi/">K8sApi</a>.BaseKubeJsonApiObjectMetadata</p>
<h2 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h2>
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>Namespaced</code></td>
<td align="left">extends <code>KubeObjectScope</code></td>
</tr>
</tbody>
</table>
<h2 id="indexable">Indexable<a class="headerlink" href="#indexable" title="Permanent link">#</a></h2>
<p>▪ [key: <code>string</code>]: <code>unknown</code></p>
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
<ul>
<li><a href="./#annotations">annotations</a></li>
<li><a href="./#clustername">clusterName</a></li>
<li><a href="./#creationtimestamp">creationTimestamp</a></li>
<li><a href="./#deletiongraceperiodseconds">deletionGracePeriodSeconds</a></li>
<li><a href="./#deletiontimestamp">deletionTimestamp</a></li>
<li><a href="./#finalizers">finalizers</a></li>
<li><a href="./#generatename">generateName</a></li>
<li><a href="./#generation">generation</a></li>
<li><a href="./#labels">labels</a></li>
<li><a href="./#managedfields">managedFields</a></li>
<li><a href="./#name">name</a></li>
<li><a href="./#namespace">namespace</a></li>
<li><a href="./#ownerreferences">ownerReferences</a></li>
<li><a href="./#resourceversion">resourceVersion</a></li>
<li><a href="./#selflink">selfLink</a></li>
<li><a href="./#uid">uid</a></li>
</ul>
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="annotations">annotations<a class="headerlink" href="#annotations" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>annotations</strong>: <code>Partial</code>&lt;<code>Record</code>&lt;<code>string</code>, <code>string</code>>></p>
<p>Annotations is an unstructured key value map stored with a resource that may be set by
external tools to store and retrieve arbitrary metadata. They are not queryable and should be
preserved when modifying objects.</p>
<p>More info: http://kubernetes.io/docs/user-guide/annotations</p>
<hr />
<h3 id="clustername">clusterName<a class="headerlink" href="#clustername" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>clusterName</strong>: <code>string</code></p>
<p>The name of the cluster which the object belongs to. This is used to distinguish resources
with same name and namespace in different clusters. This field is not set anywhere right now
and api server is going to ignore it if set in create or update request.</p>
<hr />
<h3 id="creationtimestamp">creationTimestamp<a class="headerlink" href="#creationtimestamp" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <code>Readonly</code> <strong>creationTimestamp</strong>: <code>string</code></p>
<p>CreationTimestamp is a timestamp representing the server time when this object was created. It
is not guaranteed to be set in happens-before order across separate operations. Clients may
not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system.</p>
<p>More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata</p>
<hr />
<h3 id="deletiongraceperiodseconds">deletionGracePeriodSeconds<a class="headerlink" href="#deletiongraceperiodseconds" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <code>Readonly</code> <strong>deletionGracePeriodSeconds</strong>: <code>number</code></p>
<p>Number of seconds allowed for this object to gracefully terminate before it will be removed
from the system. Only set when deletionTimestamp is also set. May only be shortened.</p>
<hr />
<h3 id="deletiontimestamp">deletionTimestamp<a class="headerlink" href="#deletiontimestamp" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <code>Readonly</code> <strong>deletionTimestamp</strong>: <code>string</code></p>
<p>DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field
is set by the server when a graceful deletion is requested by the user, and is not directly
settable by a client. The resource is expected to be deleted (no longer visible from resource
lists, and not reachable by name) after the time in this field, once the finalizers list is
empty. As long as the finalizers list contains items, deletion is blocked. Once the
<code>deletionTimestamp</code> is set, this value may not be unset or be set further into the future,
although it may be shortened or the resource may be deleted prior to this time. For example,
a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a
graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet
will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the
pod from the API. In the presence of network partitions, this object may still exist after
this timestamp, until an administrator or automated process can determine the resource is
fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested.</p>
<p>More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata</p>
<hr />
<h3 id="finalizers">finalizers<a class="headerlink" href="#finalizers" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>finalizers</strong>: <code>string</code>[]</p>
<p>Must be empty before the object is deleted from the registry. Each entry is an identifier for
the responsible component that will remove the entry from the list. If the deletionTimestamp
of the object is non-nil, entries in this list can only be removed. Finalizers may be
processed and removed in any order. Order is NOT enforced because it introduces significant
risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder
it. If the finalizer list is processed in order, then this can lead to a situation in which
the component responsible for the first finalizer in the list is waiting for a signal (field
value, external system, or other) produced by a component responsible for a finalizer later in
the list, resulting in a deadlock. Without enforced ordering finalizers are free to order
amongst themselves and are not vulnerable to ordering changes in the list.</p>
<hr />
<h3 id="generatename">generateName<a class="headerlink" href="#generatename" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>generateName</strong>: <code>string</code></p>
<p>GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the
Name field has not been provided. If this field is used, the name returned to the client will
be different than the name passed. This value will also be combined with a unique suffix. The
provided value has the same validation rules as the Name field, and may be truncated by the
length of the suffix required to make the value unique on the server. If this field is
specified and the generated name exists, the server will NOT return a 409 - instead, it will
either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not
be found in the time allotted, and the client should retry (optionally after the time indicated
in the Retry-After header). Applied only if Name is not specified.</p>
<p>More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency</p>
<hr />
<h3 id="generation">generation<a class="headerlink" href="#generation" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <code>Readonly</code> <strong>generation</strong>: <code>number</code></p>
<p>A sequence number representing a specific generation of the desired state. Populated by the
system.</p>
<hr />
<h3 id="labels">labels<a class="headerlink" href="#labels" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>labels</strong>: <code>Partial</code>&lt;<code>Record</code>&lt;<code>string</code>, <code>string</code>>></p>
<p>Map of string keys and values that can be used to organize and categorize (scope and select)
objects. May match selectors of replication controllers and services.</p>
<p>More info: http://kubernetes.io/docs/user-guide/labels</p>
<hr />
<h3 id="managedfields">managedFields<a class="headerlink" href="#managedfields" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>managedFields</strong>: <code>unknown</code>[]</p>
<p>ManagedFields maps workflow-id and version to the set of fields that are managed by that
workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set
or understand this field. A workflow can be the user's name, a controller's name, or the name
of a specific apply path like "ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.</p>
<hr />
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>name</strong>: <code>string</code></p>
<p>Name must be unique within a namespace. Is required when creating resources, although some
resources may allow a client to request the generation of an appropriate name automatically.
Name is primarily intended for creation idempotence and configuration definition.</p>
<p>More info: http://kubernetes.io/docs/user-guide/identifiers#names</p>
<hr />
<h3 id="namespace">namespace<a class="headerlink" href="#namespace" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <code>Readonly</code> <strong>namespace</strong>: <code>ScopedNamespace</code>&lt;<code>Namespaced</code>></p>
<p>Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation. Not all
objects are required to be scoped to a namespace - the value of this field for those objects
will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces</p>
<hr />
<h3 id="ownerreferences">ownerReferences<a class="headerlink" href="#ownerreferences" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>ownerReferences</strong>: <a href="../Main.K8sApi.OwnerReference/"><code>OwnerReference</code></a>[]</p>
<p>List of objects depended by this object. If ALL objects in the list have been deleted, this
object will be garbage collected. If this object is managed by a controller, then an entry in
this list will point to this controller, with the controller field set to true. There cannot
be more than one managing controller.</p>
<hr />
<h3 id="resourceversion">resourceVersion<a class="headerlink" href="#resourceversion" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <code>Readonly</code> <strong>resourceVersion</strong>: <code>string</code></p>
<p>An opaque value that represents the internal version of this object that can be used by
clients to determine when objects have changed. May be used for optimistic concurrency, change
detection, and the watch operation on a resource or set of resources. Clients must treat these
values as opaque and passed unmodified back to the server. They may only be valid for a
particular resource or set of resources. Populated by the system. Value must be treated as
opaque by clients.</p>
<p>More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency</p>
<hr />
<h3 id="selflink">selfLink<a class="headerlink" href="#selflink" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <code>Readonly</code> <strong>selfLink</strong>: <code>string</code></p>
<p>SelfLink is a URL representing this object. Populated by the system.</p>
<hr />
<h3 id="uid">uid<a class="headerlink" href="#uid" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <code>Readonly</code> <strong>uid</strong>: <code>string</code></p>
<p>UID is the unique in time and space value for this object. It is typically generated by the
server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system.</p>
<p>More info: http://kubernetes.io/docs/user-guide/identifiers#uids</p>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Copyright &copy; 2021 <a href="https://mirantis.com/">Mirantis Inc.</a> - All rights reserved.
</div>
</div>
<div class="md-social">
<a href="https://github.com/lensapp/lens" target="_blank" rel="noopener" title="Lens on GitHub" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</a>
<a href="https://twitter.com/k8slens" target="_blank" rel="noopener" title="Lens on Twitter" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg>
</a>
<a href="https://forums.k8slens.dev/" target="_blank" rel="noopener" title="Lens Forums" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M225.9 32C103.3 32 0 130.5 0 252.1 0 256 .1 480 .1 480l225.8-.2c122.7 0 222.1-102.3 222.1-223.9C448 134.3 348.6 32 225.9 32zM224 384c-19.4 0-37.9-4.3-54.4-12.1L88.5 392l22.9-75c-9.8-18.1-15.4-38.9-15.4-61 0-70.7 57.3-128 128-128s128 57.3 128 128-57.3 128-128 128z"/></svg>
</a>
<a href="https://k8slens.dev/" target="_blank" rel="noopener" title="Lens Website" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M579.8 267.7c56.5-56.5 56.5-148 0-204.5-50-50-128.8-56.5-186.3-15.4l-1.6 1.1c-14.4 10.3-17.7 30.3-7.4 44.6s30.3 17.7 44.6 7.4l1.6-1.1c32.1-22.9 76-19.3 103.8 8.6 31.5 31.5 31.5 82.5 0 114L422.3 334.8c-31.5 31.5-82.5 31.5-114 0-27.9-27.9-31.5-71.8-8.6-103.8l1.1-1.6c10.3-14.4 6.9-34.4-7.4-44.6s-34.4-6.9-44.6 7.4l-1.1 1.6C206.5 251.2 213 330 263 380c56.5 56.5 148 56.5 204.5 0l112.3-112.3zM60.2 244.3c-56.5 56.5-56.5 148 0 204.5 50 50 128.8 56.5 186.3 15.4l1.6-1.1c14.4-10.3 17.7-30.3 7.4-44.6s-30.3-17.7-44.6-7.4l-1.6 1.1c-32.1 22.9-76 19.3-103.8-8.6C74 372 74 321 105.5 289.5l112.2-112.3c31.5-31.5 82.5-31.5 114 0 27.9 27.9 31.5 71.8 8.6 103.9l-1.1 1.6c-10.3 14.4-6.9 34.4 7.4 44.6s34.4 6.9 44.6-7.4l1.1-1.6C433.5 260.8 427 182 377 132c-56.5-56.5-148-56.5-204.5 0L60.2 244.3z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../../../..", "features": ["toc.autohide", "search.suggest", "search.highlight", "content.code.copy"], "search": "../../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
<script src="../../../../assets/javascripts/bundle.c2be25ad.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink