{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Lens Extension API","text":"
Customize and enhance the Lens experience with the Lens Extension API. Use the extension API to create menus or page content. The same extension API was used to create many of Lens's core features. To install your first extension you should goto the extension page in lens.
This documentation describes:
Here are some examples of what you can achieve with the Extension API:
For an overview of the Lens Extension API, refer to the Common Capabilities page. Extension Guides Overview also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API.
"},{"location":"#how-to-build-extensions","title":"How to Build Extensions","text":"Here is what each section of the Lens Extension API docs can help you with:
Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release.
Keep up with Lens and the Lens Extension API by reviewing the release notes.
"},{"location":"#important-changes-since-lens-v4","title":"Important changes since Lens v4","text":"Lens has undergone major design improvements in v5, which have resulted in several large changes to the extension API. Workspaces are gone, and the catalog is introduced for containing clusters, as well as other items, including custom entities. Lens has migrated from using mobx 5 to mobx 6 for internal state management, and this may have ramifications for extension implementations. Although the API retains many components from v4, given these changes, extensions written for Lens v4 are not compatible with the Lens v5 extension API. See the Lens v4 to v5 extension migration notes on getting old extensions working in Lens v5.
"},{"location":"#looking-for-help","title":"Looking for Help","text":"If you have questions for extension development, try asking on the Lens Forums. It's a public chatroom for Lens developers, where Lens team members chime in from time to time.
To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens. Please use the labels area/documentation and/or area/extension.
Download Lens for macOS, Windows, or Linux.
"},{"location":"architecture/decisions/","title":"Architecture Decision Records","text":""},{"location":"extensions/extension-migration/","title":"Lens v4 to v5 Extension Migration Notes","text":"package.json for your extension must have an \"engines\" field specifying the lens version that your extension is targeted for, e.g: \"engines\": {\n \"lens\": \"^5.0.0-beta.7\"\n },\n Note that Lens v5 supports all the range semantics that semver provides.Main and Renderer) plus those not specific to a process (Common). For example the LensMainExtension class is now referred to by Main.LensExtension. See the API Reference for the new organization.globalPageMenus field of the Renderer extension class (now Renderer.LensExtension) is removed. Global pages can still be made accessible via the application menus and the status bar, as well as from the newly added Welcome menu.clusterFeatures field of the Renderer extension class (now Renderer.LensExtension) is removed. Cluster features can still be implemented but Lens no longer dictates how a feature's lifecycle (install/upgrade/uninstall) is managed. Renderer.K8sApi.ResourceStack provides the functionality to input and apply kubernetes resources to a cluster. It is up to the extension developer to manage the lifecycle. It could be applied automatically to a cluster by the extension or the end-user could be expected to install it, etc. from the cluster Settings page.For an example of an existing extension that is compatible with Lens v5 see the Lens Resource Map Extension
"},{"location":"extensions/api/","title":"API Reference","text":"@k8slens/extensions / Exports
"},{"location":"extensions/api/#extension-api-reference","title":"Extension API Reference","text":""},{"location":"extensions/api/#apis","title":"APIs","text":"@k8slens/extensions / Exports
"},{"location":"extensions/api/modules/#k8slensextensions","title":"@k8slens/extensions","text":""},{"location":"extensions/api/modules/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/#namespaces","title":"Namespaces","text":"@k8slens/extensions / Exports / Common / Catalog / CatalogCategory
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#class-catalogcategory","title":"Class: CatalogCategory","text":"Common.Catalog.CatalogCategory
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#hierarchy","title":"Hierarchy","text":"CatalogCategory_base\u21b3 CatalogCategory
\u21b3\u21b3 KubernetesClusterCategory
\u2022 new CatalogCategory()
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#inherited-from","title":"Inherited from","text":"CatalogCategory_base.constructor
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#apiversion","title":"apiVersion","text":"\u2022 Readonly Abstract apiVersion: string
The version of category that you are wanting to declare.
Currently supported values:
\"catalog.k8slens.dev/v1alpha1\"\u2022 Protected Readonly filters: ObservableSet<AddMenuFilter>
\u2022 Readonly Abstract kind: string
The kind of item you wish to declare.
Currently supported values:
\"CatalogCategory\"\u2022 Readonly Abstract metadata: CatalogCategoryMetadata
The data about the category itself
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#spec","title":"spec","text":"\u2022 Readonly Abstract spec: CatalogCategorySpec
The most important part of a category, as it is where entity versions are declared.
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#addmenufilter","title":"addMenuFilter","text":"\u25b8 addMenuFilter(fn): Disposer
Add a filter for menu items of catalogAddMenu
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#parameters","title":"Parameters","text":"Name Type Descriptionfn AddMenuFilter The function that should return a truthy value if that menu item should be displayed"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns","title":"Returns","text":"Disposer
A function to remove that filter
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#filtereditems","title":"filteredItems","text":"\u25b8 filteredItems(menuItems): CatalogEntityAddMenu[]
Filter menuItems according to the Category's set filters
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#parameters_1","title":"Parameters","text":"Name Type DescriptionmenuItems CatalogEntityAddMenu[] menu items to filter"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns_1","title":"Returns","text":"CatalogEntityAddMenu[]
filtered menu items
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getbadge","title":"getBadge","text":"\u25b8 getBadge(): StrictReactNode
Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns_2","title":"Returns","text":"StrictReactNode
\u25b8 getId(): string
Get the ID of this category
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns_3","title":"Returns","text":"string
\u25b8 getName(): string
Get the name of this category
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns_4","title":"Returns","text":"string
\u25b8 Static parseId(id): Object
Parse a category ID into parts.
"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#parameters_2","title":"Parameters","text":"Name Type Descriptionid string The id of a category is parse"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#returns_5","title":"Returns","text":"Object
The group and kind parts of the ID
Name Typegroup? string kind? string"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/","title":"Common.Catalog.CatalogEntity","text":"@k8slens/extensions / Exports / Common / Catalog / CatalogEntity
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#class-catalogentitymetadata-status-spec","title":"Class: CatalogEntity<Metadata, Status, Spec>","text":"Common.Catalog.CatalogEntity
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends CatalogEntityMetadata = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#hierarchy","title":"Hierarchy","text":"CatalogEntity\u21b3 KubernetesCluster
\u21b3 GeneralEntity
\u21b3 WebLink
CatalogEntityKindData\u2022 new CatalogEntity<Metadata, Status, Spec>(\u00abdestructured\u00bb)
Metadata extends CatalogEntityMetadata<Metadata> = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb CatalogEntityData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#apiversion","title":"apiVersion","text":"\u2022 Readonly Abstract apiVersion: string
The group and version of this class.
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#implementation-of","title":"Implementation of","text":"CatalogEntityKindData.apiVersion
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#kind","title":"kind","text":"\u2022 Readonly Abstract kind: string
A DNS label name of the entity.
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#implementation-of_1","title":"Implementation of","text":"CatalogEntityKindData.kind
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#metadata","title":"metadata","text":"\u2022 metadata: Metadata
\u2022 spec: Spec
\u2022 status: Status
\u25b8 getId(): string
Get the UID of this entity
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns","title":"Returns","text":"string
\u25b8 getName(): string
Get the name of this entity
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_1","title":"Returns","text":"string
\u25b8 getSource(): string
Get the specified source of this entity, defaulting to \"unknown\" if not provided
string
\u25b8 isEnabled(): boolean
Get if this entity is enabled.
"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_3","title":"Returns","text":"boolean
\u25b8 Optional onContextMenuOpen(context): void | Promise<void>
context CatalogEntityContextMenuContext"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_4","title":"Returns","text":"void | Promise<void>
\u25b8 Optional onRun(context): void | Promise<void>
context CatalogEntityActionContext"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_5","title":"Returns","text":"void | Promise<void>
\u25b8 Optional onSettingsOpen(context): void | Promise<void>
context CatalogEntitySettingsContext"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#returns_6","title":"Returns","text":"void | Promise<void>
@k8slens/extensions / Exports / Common / Catalog / GeneralEntity
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#class-generalentity","title":"Class: GeneralEntity","text":"Common.Catalog.GeneralEntity
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#hierarchy","title":"Hierarchy","text":"CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, GeneralEntitySpec>\u21b3 GeneralEntity
\u2022 new GeneralEntity(\u00abdestructured\u00bb)
\u00abdestructured\u00bb CatalogEntityData<CatalogEntityMetadata, CatalogEntityStatus, GeneralEntitySpec>"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#inherited-from","title":"Inherited from","text":"CatalogEntity.constructor
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#apiversion","title":"apiVersion","text":"\u2022 Readonly apiVersion: \"entity.k8slens.dev/v1alpha1\"
The group and version of this class.
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#overrides","title":"Overrides","text":"CatalogEntity.apiVersion
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#kind","title":"kind","text":"\u2022 Readonly kind: \"General\"
A DNS label name of the entity.
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#overrides_1","title":"Overrides","text":"CatalogEntity.kind
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#metadata","title":"metadata","text":"\u2022 metadata: CatalogEntityMetadata
CatalogEntity.metadata
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#spec","title":"spec","text":"\u2022 spec: GeneralEntitySpec
CatalogEntity.spec
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#status","title":"status","text":"\u2022 status: CatalogEntityStatus
CatalogEntity.status
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getid","title":"getId","text":"\u25b8 getId(): string
Get the UID of this entity
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns","title":"Returns","text":"string
CatalogEntity.getId
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getname","title":"getName","text":"\u25b8 getName(): string
Get the name of this entity
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_1","title":"Returns","text":"string
CatalogEntity.getName
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getsource","title":"getSource","text":"\u25b8 getSource(): string
Get the specified source of this entity, defaulting to \"unknown\" if not provided
string
CatalogEntity.getSource
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#isenabled","title":"isEnabled","text":"\u25b8 isEnabled(): boolean
Get if this entity is enabled.
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_3","title":"Returns","text":"boolean
CatalogEntity.isEnabled
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#oncontextmenuopen","title":"onContextMenuOpen","text":"\u25b8 Optional onContextMenuOpen(context): void | Promise<void>
context CatalogEntityContextMenuContext"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_4","title":"Returns","text":"void | Promise<void>
CatalogEntity.onContextMenuOpen
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#onrun","title":"onRun","text":"\u25b8 onRun(context): Promise<void>
context CatalogEntityActionContext"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_5","title":"Returns","text":"Promise<void>
CatalogEntity.onRun
"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#onsettingsopen","title":"onSettingsOpen","text":"\u25b8 Optional onSettingsOpen(context): void | Promise<void>
context CatalogEntitySettingsContext"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#returns_6","title":"Returns","text":"void | Promise<void>
CatalogEntity.onSettingsOpen
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/","title":"Common.Catalog.KubernetesCluster","text":"@k8slens/extensions / Exports / Common / Catalog / KubernetesCluster
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#class-kubernetesclustermetadata-status-spec","title":"Class: KubernetesCluster<Metadata, Status, Spec>","text":"Common.Catalog.KubernetesCluster
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubernetesClusterMetadata = KubernetesClusterMetadata Status extends KubernetesClusterStatus = KubernetesClusterStatus Spec extends KubernetesClusterSpec = KubernetesClusterSpec"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#hierarchy","title":"Hierarchy","text":"CatalogEntity<Metadata, Status, Spec>\u21b3 KubernetesCluster
\u2022 new KubernetesCluster<Metadata, Status, Spec>(\u00abdestructured\u00bb)
Metadata extends KubernetesClusterMetadata<Metadata> = KubernetesClusterMetadata Status extends KubernetesClusterStatus = KubernetesClusterStatus Spec extends KubernetesClusterSpec<Spec> = KubernetesClusterSpec"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#parameters","title":"Parameters","text":"Name Type \u00abdestructured\u00bb CatalogEntityData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#inherited-from","title":"Inherited from","text":"CatalogEntity.constructor
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#apiversion","title":"apiVersion","text":"\u2022 Readonly apiVersion: string
The group and version of this class.
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#overrides","title":"Overrides","text":"CatalogEntity.apiVersion
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#kind","title":"kind","text":"\u2022 Readonly kind: string
A DNS label name of the entity.
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#overrides_1","title":"Overrides","text":"CatalogEntity.kind
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#metadata","title":"metadata","text":"\u2022 metadata: Metadata
CatalogEntity.metadata
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#spec","title":"spec","text":"\u2022 spec: Spec
CatalogEntity.spec
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#status","title":"status","text":"\u2022 status: Status
CatalogEntity.status
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#apiversion_1","title":"apiVersion","text":"\u25aa Static Readonly apiVersion: string
\u25aa Static Readonly kind: string
\u25b8 connect(): Promise<void>
Promise<void>
\u25b8 disconnect(): Promise<void>
Promise<void>
\u25b8 getId(): string
Get the UID of this entity
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_2","title":"Returns","text":"string
CatalogEntity.getId
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getname","title":"getName","text":"\u25b8 getName(): string
Get the name of this entity
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_3","title":"Returns","text":"string
CatalogEntity.getName
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getsource","title":"getSource","text":"\u25b8 getSource(): string
Get the specified source of this entity, defaulting to \"unknown\" if not provided
string
CatalogEntity.getSource
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#isenabled","title":"isEnabled","text":"\u25b8 isEnabled(): boolean
Get if this entity is enabled.
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_5","title":"Returns","text":"boolean
CatalogEntity.isEnabled
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#oncontextmenuopen","title":"onContextMenuOpen","text":"\u25b8 onContextMenuOpen(context): void
context CatalogEntityContextMenuContext"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_6","title":"Returns","text":"void
CatalogEntity.onContextMenuOpen
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#ondetailsopen","title":"onDetailsOpen","text":"\u25b8 onDetailsOpen(): void
void
\u25b8 onRun(context): Promise<void>
context CatalogEntityActionContext"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#returns_8","title":"Returns","text":"Promise<void>
CatalogEntity.onRun
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#onsettingsopen","title":"onSettingsOpen","text":"\u25b8 onSettingsOpen(): void
void
CatalogEntity.onSettingsOpen
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/","title":"Common.Catalog.KubernetesClusterCategory","text":"@k8slens/extensions / Exports / Common / Catalog / KubernetesClusterCategory
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#class-kubernetesclustercategory","title":"Class: KubernetesClusterCategory","text":"Common.Catalog.KubernetesClusterCategory
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#hierarchy","title":"Hierarchy","text":"CatalogCategory\u21b3 KubernetesClusterCategory
\u2022 new KubernetesClusterCategory()
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from","title":"Inherited from","text":"CatalogCategory.constructor
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#apiversion","title":"apiVersion","text":"\u2022 Readonly apiVersion: \"catalog.k8slens.dev/v1alpha1\"
The version of category that you are wanting to declare.
Currently supported values:
\"catalog.k8slens.dev/v1alpha1\"CatalogCategory.apiVersion
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#filters","title":"filters","text":"\u2022 Protected Readonly filters: ObservableSet<AddMenuFilter>
CatalogCategory.filters
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#kind","title":"kind","text":"\u2022 Readonly kind: \"CatalogCategory\"
The kind of item you wish to declare.
Currently supported values:
\"CatalogCategory\"CatalogCategory.kind
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#metadata","title":"metadata","text":"\u2022 metadata: Object
The data about the category itself
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#type-declaration","title":"Type declaration","text":"Name Typeicon string name string"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#overrides_2","title":"Overrides","text":"CatalogCategory.metadata
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#spec","title":"spec","text":"\u2022 spec: CatalogCategorySpec
The most important part of a category, as it is where entity versions are declared.
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#overrides_3","title":"Overrides","text":"CatalogCategory.spec
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#addmenufilter","title":"addMenuFilter","text":"\u25b8 addMenuFilter(fn): Disposer
Add a filter for menu items of catalogAddMenu
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#parameters","title":"Parameters","text":"Name Type Descriptionfn AddMenuFilter The function that should return a truthy value if that menu item should be displayed"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns","title":"Returns","text":"Disposer
A function to remove that filter
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_2","title":"Inherited from","text":"CatalogCategory.addMenuFilter
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#filtereditems","title":"filteredItems","text":"\u25b8 filteredItems(menuItems): CatalogEntityAddMenu[]
Filter menuItems according to the Category's set filters
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#parameters_1","title":"Parameters","text":"Name Type DescriptionmenuItems CatalogEntityAddMenu[] menu items to filter"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns_1","title":"Returns","text":"CatalogEntityAddMenu[]
filtered menu items
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_3","title":"Inherited from","text":"CatalogCategory.filteredItems
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#getbadge","title":"getBadge","text":"\u25b8 getBadge(): StrictReactNode
Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns_2","title":"Returns","text":"StrictReactNode
CatalogCategory.getBadge
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#getid","title":"getId","text":"\u25b8 getId(): string
Get the ID of this category
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns_3","title":"Returns","text":"string
CatalogCategory.getId
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#getname","title":"getName","text":"\u25b8 getName(): string
Get the name of this category
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns_4","title":"Returns","text":"string
CatalogCategory.getName
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#parseid","title":"parseId","text":"\u25b8 Static parseId(id): Object
Parse a category ID into parts.
"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#parameters_2","title":"Parameters","text":"Name Type Descriptionid string The id of a category is parse"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#returns_5","title":"Returns","text":"Object
The group and kind parts of the ID
Name Typegroup? string kind? string"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#inherited-from_7","title":"Inherited from","text":"CatalogCategory.parseId
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/","title":"Common.Catalog.WebLink","text":"@k8slens/extensions / Exports / Common / Catalog / WebLink
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#class-weblink","title":"Class: WebLink","text":"Common.Catalog.WebLink
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#hierarchy","title":"Hierarchy","text":"CatalogEntity<CatalogEntityMetadata, WebLinkStatus, WebLinkSpec>\u21b3 WebLink
\u2022 new WebLink(\u00abdestructured\u00bb)
\u00abdestructured\u00bb CatalogEntityData<CatalogEntityMetadata, WebLinkStatus, WebLinkSpec>"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#inherited-from","title":"Inherited from","text":"CatalogEntity.constructor
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Catalog.WebLink/#apiversion","title":"apiVersion","text":"\u2022 Readonly apiVersion: \"entity.k8slens.dev/v1alpha1\"
The group and version of this class.
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#overrides","title":"Overrides","text":"CatalogEntity.apiVersion
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#kind","title":"kind","text":"\u2022 Readonly kind: \"WebLink\"
A DNS label name of the entity.
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#overrides_1","title":"Overrides","text":"CatalogEntity.kind
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#metadata","title":"metadata","text":"\u2022 metadata: CatalogEntityMetadata
CatalogEntity.metadata
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#spec","title":"spec","text":"\u2022 spec: WebLinkSpec
CatalogEntity.spec
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#status","title":"status","text":"\u2022 status: WebLinkStatus
CatalogEntity.status
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#apiversion_1","title":"apiVersion","text":"\u25aa Static Readonly apiVersion: \"entity.k8slens.dev/v1alpha1\"
\u25aa Static Readonly kind: \"WebLink\"
\u25b8 getId(): string
Get the UID of this entity
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns","title":"Returns","text":"string
CatalogEntity.getId
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getname","title":"getName","text":"\u25b8 getName(): string
Get the name of this entity
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_1","title":"Returns","text":"string
CatalogEntity.getName
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getsource","title":"getSource","text":"\u25b8 getSource(): string
Get the specified source of this entity, defaulting to \"unknown\" if not provided
string
CatalogEntity.getSource
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#isenabled","title":"isEnabled","text":"\u25b8 isEnabled(): boolean
Get if this entity is enabled.
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_3","title":"Returns","text":"boolean
CatalogEntity.isEnabled
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#oncontextmenuopen","title":"onContextMenuOpen","text":"\u25b8 onContextMenuOpen(context): void
context CatalogEntityContextMenuContext"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_4","title":"Returns","text":"void
CatalogEntity.onContextMenuOpen
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#onrun","title":"onRun","text":"\u25b8 onRun(): Promise<void>
Promise<void>
CatalogEntity.onRun
"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#onsettingsopen","title":"onSettingsOpen","text":"\u25b8 Optional onSettingsOpen(context): void | Promise<void>
context CatalogEntitySettingsContext"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#returns_6","title":"Returns","text":"void | Promise<void>
CatalogEntity.onSettingsOpen
"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/","title":"Common.EventBus.EventEmitter","text":"@k8slens/extensions / Exports / Common / EventBus / EventEmitter
"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#class-eventemitterd","title":"Class: EventEmitter<D>","text":"Common.EventBus.EventEmitter
"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#type-parameters","title":"Type parameters","text":"Name TypeD extends any[]"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#constructors","title":"Constructors","text":"\u2022 new EventEmitter<D>()
D extends any[]"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#listeners","title":"listeners","text":"\u2022 Protected listeners: [EventEmitterCallback<D>, EventEmitterOptions][]
\u25b8 addListener(callback, options?): void
callback EventEmitterCallback<D> options? EventEmitterOptions"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#returns","title":"Returns","text":"void
\u25b8 emit(...data): void
...data D"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#returns_1","title":"Returns","text":"void
\u25b8 removeAllListeners(): void
void
\u25b8 removeListener(callback): void
callback EventEmitterCallback<D>"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#returns_3","title":"Returns","text":"void
@k8slens/extensions / Exports / Common / LensExtension
"},{"location":"extensions/api/classes/Common.LensExtension/#class-lensextension","title":"Class: LensExtension","text":"Common.LensExtension
"},{"location":"extensions/api/classes/Common.LensExtension/#hierarchy","title":"Hierarchy","text":"LensExtension\u21b3 LensExtension
\u21b3 LensExtension
\u2022 new LensExtension(deps, \u00abdestructured\u00bb)
deps LensExtensionDependencies \u00abdestructured\u00bb InstalledExtension"},{"location":"extensions/api/classes/Common.LensExtension/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.LensExtension/#id","title":"id","text":"\u2022 Readonly id: string
\u2022 Readonly isBundled: boolean
\u2022 Readonly manifest: LensExtensionManifest
\u2022 Readonly manifestPath: string
\u2022 protocolHandlers: ProtocolHandlerRegistration[]
\u2022 get description(): undefined | string
undefined | string
\u2022 get isEnabled(): boolean
boolean
\u2022 get name(): string
string
\u2022 get sanitizedExtensionId(): string
string
\u2022 get storeName(): string
string
\u2022 get version(): string
string
\u25b8 activate(): Promise<void>
Promise<void>
\u25b8 disable(): Promise<void>
Promise<void>
\u25b8 enable(): Promise<void>
Promise<void>
\u25b8 getExtensionFileFolder(): Promise<string>
getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension.
Note: there is no security done on this folder, only obfuscation of the folder name.
"},{"location":"extensions/api/classes/Common.LensExtension/#returns_9","title":"Returns","text":"Promise<string>
\u25b8 Protected onActivate(): void | Promise<void>
void | Promise<void>
\u25b8 Protected onDeactivate(): void | Promise<void>
void | Promise<void>
@k8slens/extensions / Exports / Common / Store / ExtensionStore
"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#class-extensionstoret","title":"Class: ExtensionStore<T>","text":"Common.Store.ExtensionStore
"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#type-parameters","title":"Type parameters","text":"Name TypeT extends object"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructors","title":"Constructors","text":"\u2022 new ExtensionStore<T>(rawParams)
T extends object"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters","title":"Parameters","text":"Name Type rawParams ExtensionStoreParams<T>"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#extension","title":"extension","text":"\u2022 Protected Optional extension: LensExtension
\u2022 Protected Optional persistentStorage: PersistentStorage
\u2022 Protected Readonly rawParams: ExtensionStoreParams<T>
\u25b8 Protected cwd(): string
string
\u25b8 Abstract fromStore(data): void
data Partial<T>"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_1","title":"Returns","text":"void
\u25b8 load(): void
Deprecated
Never use this method. Instead call loadExtension
"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_2","title":"Returns","text":"void
\u25b8 loadExtension(extension): void
extension LensExtension"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_3","title":"Returns","text":"void
\u25b8 Abstract toJSON(): T
T
\u25b8 Static createInstance<T, R>(this, ...args): T
Deprecated
This is a form of global shared state. Just call new Store(...)
T T R extends any[]"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters_3","title":"Parameters","text":"Name Type this StaticThis<T, R> ...args R"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_5","title":"Returns","text":"T
\u25b8 Static getInstance<T, R>(this, strict?): T
Deprecated
This is a form of global shared state. Just call new Store(...)
T T R extends any[]"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters_4","title":"Parameters","text":"Name Type this StaticThis<T, R> strict? true"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_6","title":"Returns","text":"T
\u25b8 Static getInstance<T, R>(this, strict): undefined | T
T T R extends any[]"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#parameters_5","title":"Parameters","text":"Name Type this StaticThis<T, R> strict false"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#returns_7","title":"Returns","text":"undefined | T
\u25b8 Static resetInstance(): void
Deprecated
This is a form of global shared state. Just call new Store(...)
void
@k8slens/extensions / Exports / Common / Util / Singleton
"},{"location":"extensions/api/classes/Common.Util.Singleton/#class-singleton","title":"Class: Singleton","text":"Common.Util.Singleton
Deprecated
This is a form of global shared state
"},{"location":"extensions/api/classes/Common.Util.Singleton/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Common.Util.Singleton/#constructors","title":"Constructors","text":"\u2022 new Singleton()
"},{"location":"extensions/api/classes/Common.Util.Singleton/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Common.Util.Singleton/#createinstance","title":"createInstance","text":"\u25b8 Static createInstance<T, R>(this, ...args): T
Creates the single instance of the child class if one was not already created.
Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls.
Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.
"},{"location":"extensions/api/classes/Common.Util.Singleton/#type-parameters","title":"Type parameters","text":"Name TypeT extends Singleton<T> R extends any[]"},{"location":"extensions/api/classes/Common.Util.Singleton/#parameters","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type ...args R The constructor arguments for the child class"},{"location":"extensions/api/classes/Common.Util.Singleton/#returns","title":"Returns","text":"T
An instance of the child class
"},{"location":"extensions/api/classes/Common.Util.Singleton/#getinstance","title":"getInstance","text":"\u25b8 Static getInstance<T, R>(this, strict?): T
Get the instance of the child class that was previously created.
"},{"location":"extensions/api/classes/Common.Util.Singleton/#type-parameters_1","title":"Type parameters","text":"Name TypeT T R extends any[]"},{"location":"extensions/api/classes/Common.Util.Singleton/#parameters_1","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type strict? true If false will return undefined instead of throwing when an instance doesn't exist. Default: true"},{"location":"extensions/api/classes/Common.Util.Singleton/#returns_1","title":"Returns","text":"T
An instance of the child class
\u25b8 Static getInstance<T, R>(this, strict): undefined | T
T T R extends any[]"},{"location":"extensions/api/classes/Common.Util.Singleton/#parameters_2","title":"Parameters","text":"Name Type this StaticThis<T, R> strict false"},{"location":"extensions/api/classes/Common.Util.Singleton/#returns_2","title":"Returns","text":"undefined | T
\u25b8 Static resetInstance(): void
Delete the instance of the child class.
Note: this doesn't prevent callers of getInstance from storing the result in a global.
There is no way in JS or TS to prevent globals like that.
"},{"location":"extensions/api/classes/Common.Util.Singleton/#returns_3","title":"Returns","text":"void
@k8slens/extensions / Exports / Main / Ipc
"},{"location":"extensions/api/classes/Main.Ipc/#class-ipc","title":"Class: Ipc","text":"Main.Ipc
"},{"location":"extensions/api/classes/Main.Ipc/#hierarchy","title":"Hierarchy","text":"IpcRegistrar\u21b3 Ipc
\u2022 new Ipc(extension)
extension LensExtension"},{"location":"extensions/api/classes/Main.Ipc/#overrides","title":"Overrides","text":"IpcRegistrar.constructor
"},{"location":"extensions/api/classes/Main.Ipc/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.Ipc/#ipcprefix","title":"[IpcPrefix]","text":"\u2022 Readonly [IpcPrefix]: string
IpcRegistrar.[IpcPrefix]
"},{"location":"extensions/api/classes/Main.Ipc/#extension","title":"extension","text":"\u2022 Protected Readonly extension: LensExtension
IpcRegistrar.extension
"},{"location":"extensions/api/classes/Main.Ipc/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.Ipc/#broadcast","title":"broadcast","text":"\u25b8 broadcast(channel, ...args): void
channel string The channel to broadcast to your whole extension, both main and renderer ...args any[] The arguments passed to all listeners"},{"location":"extensions/api/classes/Main.Ipc/#returns","title":"Returns","text":"void
IpcRegistrar.broadcast
"},{"location":"extensions/api/classes/Main.Ipc/#handle","title":"handle","text":"\u25b8 handle(channel, handler): void
Declare a RPC over channel. Lens will cleanup when the extension is disabled or uninstalled
channel string The name of the RPC handler (event: IpcMainInvokeEvent, ...args: any[]) => any The remote procedure that is called"},{"location":"extensions/api/classes/Main.Ipc/#returns_1","title":"Returns","text":"void
\u25b8 listen(channel, listener): Disposer
Listen for broadcasts within your extension
"},{"location":"extensions/api/classes/Main.Ipc/#parameters_3","title":"Parameters","text":"Name Type Descriptionchannel string The channel to listen for broadcasts on listener (event: IpcRendererEvent, ...args: any[]) => any The function that will be called with the arguments of the broadcast"},{"location":"extensions/api/classes/Main.Ipc/#returns_2","title":"Returns","text":"Disposer
An optional disposer, Lens will cleanup when the extension is disabled or uninstalled even if this is not called
"},{"location":"extensions/api/classes/Main.Ipc/#createinstance","title":"createInstance","text":"\u25b8 Static createInstance<T, R>(this, ...args): T
Creates the single instance of the child class if one was not already created.
Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls.
Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.
"},{"location":"extensions/api/classes/Main.Ipc/#type-parameters","title":"Type parameters","text":"Name TypeT extends Singleton<T> R extends any[]"},{"location":"extensions/api/classes/Main.Ipc/#parameters_4","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type ...args R The constructor arguments for the child class"},{"location":"extensions/api/classes/Main.Ipc/#returns_3","title":"Returns","text":"T
An instance of the child class
"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from_3","title":"Inherited from","text":"IpcRegistrar.createInstance
"},{"location":"extensions/api/classes/Main.Ipc/#getinstance","title":"getInstance","text":"\u25b8 Static getInstance<T, R>(this, strict?): T
Get the instance of the child class that was previously created.
"},{"location":"extensions/api/classes/Main.Ipc/#type-parameters_1","title":"Type parameters","text":"Name TypeT T R extends any[]"},{"location":"extensions/api/classes/Main.Ipc/#parameters_5","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type strict? true If false will return undefined instead of throwing when an instance doesn't exist. Default: true"},{"location":"extensions/api/classes/Main.Ipc/#returns_4","title":"Returns","text":"T
An instance of the child class
"},{"location":"extensions/api/classes/Main.Ipc/#inherited-from_4","title":"Inherited from","text":"IpcRegistrar.getInstance
\u25b8 Static getInstance<T, R>(this, strict): undefined | T
T T R extends any[]"},{"location":"extensions/api/classes/Main.Ipc/#parameters_6","title":"Parameters","text":"Name Type this StaticThis<T, R> strict false"},{"location":"extensions/api/classes/Main.Ipc/#returns_5","title":"Returns","text":"undefined | T
IpcRegistrar.getInstance
"},{"location":"extensions/api/classes/Main.Ipc/#resetinstance","title":"resetInstance","text":"\u25b8 Static resetInstance(): void
Delete the instance of the child class.
Note: this doesn't prevent callers of getInstance from storing the result in a global.
There is no way in JS or TS to prevent globals like that.
"},{"location":"extensions/api/classes/Main.Ipc/#returns_6","title":"Returns","text":"void
IpcRegistrar.resetInstance
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/","title":"Main.K8sApi.ClusterRole","text":"@k8slens/extensions / Exports / Main / K8sApi / ClusterRole
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#class-clusterrole","title":"Class: ClusterRole","text":"Main.K8sApi.ClusterRole
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#hierarchy","title":"Hierarchy","text":"KubeObject<ClusterScopedMetadata, void, void>\u21b3 ClusterRole
\u2022 new ClusterRole(\u00abdestructured\u00bb)
\u00abdestructured\u00bb ClusterRoleData"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#overrides","title":"Overrides","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#aggregationrule","title":"aggregationRule","text":"\u2022 Optional aggregationRule: AggregationRule
\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#metadata","title":"metadata","text":"\u2022 metadata: ClusterScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#rules","title":"rules","text":"\u2022 Optional rules: PolicyRule[]
\u2022 spec: void
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#status","title":"status","text":"\u2022 Optional status: void
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#apibase","title":"apiBase","text":"\u25aa Static apiBase: string
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_6","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_8","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_11","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#kind_1","title":"kind","text":"\u25aa Static kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#namespaced","title":"namespaced","text":"\u25aa Static namespaced: boolean
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getns","title":"getNs","text":"\u25b8 getNs(): undefined
undefined
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getrules","title":"getRules","text":"\u25b8 getRules(): PolicyRule[]
PolicyRule[]
\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): (undefined | string)[]
(undefined | string)[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_24","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#patch","title":"patch","text":"\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_25","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#parameters_14","title":"Parameters","text":"Name Typedata Partial<ClusterRole>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#returns_27","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/","title":"Main.K8sApi.ClusterRoleBinding","text":"@k8slens/extensions / Exports / Main / K8sApi / ClusterRoleBinding
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#class-clusterrolebinding","title":"Class: ClusterRoleBinding","text":"Main.K8sApi.ClusterRoleBinding
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#hierarchy","title":"Hierarchy","text":"KubeObject<ClusterScopedMetadata, void, void>\u21b3 ClusterRoleBinding
\u2022 new ClusterRoleBinding(\u00abdestructured\u00bb)
\u00abdestructured\u00bb ClusterRoleBindingData"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#overrides","title":"Overrides","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#metadata","title":"metadata","text":"\u2022 metadata: ClusterScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#roleref","title":"roleRef","text":"\u2022 roleRef: RoleRef
\u2022 spec: void
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#status","title":"status","text":"\u2022 Optional status: void
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#subjects","title":"subjects","text":"\u2022 Optional subjects: Subject[]
\u25aa Static apiBase: string
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_6","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_8","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_11","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#kind_1","title":"kind","text":"\u25aa Static kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#namespaced","title":"namespaced","text":"\u25aa Static namespaced: boolean
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getns","title":"getNs","text":"\u25b8 getNs(): undefined
undefined
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): (undefined | string)[]
(undefined | string)[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getsubjectnames","title":"getSubjectNames","text":"\u25b8 getSubjectNames(): string
string
\u25b8 getSubjects(): Subject[]
Subject[]
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_25","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#patch","title":"patch","text":"\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_26","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#parameters_14","title":"Parameters","text":"Name Typedata Partial<ClusterRoleBinding>"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#returns_28","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/","title":"Main.K8sApi.ConfigMap","text":"@k8slens/extensions / Exports / Main / K8sApi / ConfigMap
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#class-configmap","title":"Class: ConfigMap","text":"Main.K8sApi.ConfigMap
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, void, void>\u21b3 ConfigMap
\u2022 new ConfigMap(\u00abdestructured\u00bb)
\u00abdestructured\u00bb ConfigMapData"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#overrides","title":"Overrides","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#binarydata","title":"binaryData","text":"\u2022 binaryData: Partial<Record<string, string>>
\u2022 data: Partial<Record<string, string>>
\u2022 Optional immutable: boolean
\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#spec","title":"spec","text":"\u2022 spec: void
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#status","title":"status","text":"\u2022 Optional status: void
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#apibase","title":"apiBase","text":"\u25aa Static apiBase: string
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_6","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_8","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_11","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#kind_1","title":"kind","text":"\u25aa Static kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#namespaced","title":"namespaced","text":"\u25aa Static namespaced: boolean
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getkeys","title":"getKeys","text":"\u25b8 getKeys(): string[]
string[]
\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_24","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#patch","title":"patch","text":"\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_25","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#parameters_14","title":"Parameters","text":"Name Typedata Partial<ConfigMap>"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#returns_27","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/","title":"Main.K8sApi.CronJob","text":"@k8slens/extensions / Exports / Main / K8sApi / CronJob
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#class-cronjob","title":"Class: CronJob","text":"Main.K8sApi.CronJob
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, CronJobStatus, CronJobSpec>\u21b3 CronJob
\u2022 new CronJob(data)
data KubeJsonApiData<NamespaceScopedMetadata, CronJobStatus, CronJobSpec>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#spec","title":"spec","text":"\u2022 spec: CronJobSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#status","title":"status","text":"\u2022 Optional status: CronJobStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#apibase","title":"apiBase","text":"\u25aa Static Readonly apiBase: \"/apis/batch/v1/cronjobs\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"CronJob\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: true
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getlastscheduletime","title":"getLastScheduleTime","text":"\u25b8 getLastScheduleTime(): string
string
\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getschedule","title":"getSchedule","text":"\u25b8 getSchedule(): string
string
\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getsuspendflag","title":"getSuspendFlag","text":"\u25b8 getSuspendFlag(): string
string
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_26","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isneverrun","title":"isNeverRun","text":"\u25b8 isNeverRun(): boolean
boolean
\u25b8 isSuspend(): undefined | boolean
undefined | boolean
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_29","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#parameters_14","title":"Parameters","text":"Name Typedata Partial<CronJob>"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#returns_31","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/","title":"Main.K8sApi.CustomResourceDefinition","text":"@k8slens/extensions / Exports / Main / K8sApi / CustomResourceDefinition
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#class-customresourcedefinition","title":"Class: CustomResourceDefinition","text":"Main.K8sApi.CustomResourceDefinition
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#hierarchy","title":"Hierarchy","text":"KubeObject<ClusterScopedMetadata, CustomResourceDefinitionStatus, CustomResourceDefinitionSpec>\u21b3 CustomResourceDefinition
\u2022 new CustomResourceDefinition(data)
data KubeJsonApiData<ClusterScopedMetadata, CustomResourceDefinitionStatus, CustomResourceDefinitionSpec>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#metadata","title":"metadata","text":"\u2022 metadata: ClusterScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#spec","title":"spec","text":"\u2022 spec: CustomResourceDefinitionSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#status","title":"status","text":"\u2022 Optional status: CustomResourceDefinitionStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#apibase","title":"apiBase","text":"\u25aa Static apiBase: string
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#kind_1","title":"kind","text":"\u25aa Static kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#namespaced","title":"namespaced","text":"\u25aa Static namespaced: boolean
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getconditions","title":"getConditions","text":"\u25b8 getConditions(): { isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]
{ isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]
\u25b8 getConversion(): string
string
\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_15","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getgroup","title":"getGroup","text":"\u25b8 getGroup(): string
string
\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getnames","title":"getNames","text":"\u25b8 getNames(): CustomResourceDefinitionNames
CustomResourceDefinitionNames
\u25b8 getNs(): undefined
undefined
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getpluralname","title":"getPluralName","text":"\u25b8 getPluralName(): string
string
\u25b8 getPreferedVersion(): CustomResourceDefinitionVersion
Deprecated
Switch to using getPreferredVersion instead (which fixes the is a typo)
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_25","title":"Returns","text":"CustomResourceDefinitionVersion
\u25b8 getPreferredVersion(): CustomResourceDefinitionVersion
CustomResourceDefinitionVersion
\u25b8 getPrinterColumns(ignorePriority?): AdditionalPrinterColumnsV1[]
ignorePriority? boolean"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_27","title":"Returns","text":"AdditionalPrinterColumnsV1[]
\u25b8 getResourceApiBase(): string
string
\u25b8 getResourceKind(): string
string
\u25b8 getResourceTitle(): string
string
\u25b8 getResourceUrl(): string
string
\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getscope","title":"getScope","text":"\u25b8 getScope(): \"Cluster\" | \"Namespaced\"
\"Cluster\" | \"Namespaced\"
\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): (undefined | string)[]
(undefined | string)[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getstoredversions","title":"getStoredVersions","text":"\u25b8 getStoredVersions(): string
string
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_37","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getvalidation","title":"getValidation","text":"\u25b8 getValidation(): string
string
\u25b8 getVersion(): string
string
\u25b8 isNamespaced(): boolean
boolean
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_14","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_41","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#parameters_15","title":"Parameters","text":"Name Typedata Partial<CustomResourceDefinition>"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#returns_43","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/","title":"Main.K8sApi.DaemonSet","text":"@k8slens/extensions / Exports / Main / K8sApi / DaemonSet
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#class-daemonset","title":"Class: DaemonSet","text":"Main.K8sApi.DaemonSet
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, DaemonSetStatus, DaemonSetSpec>\u21b3 DaemonSet
\u2022 new DaemonSet(data)
data KubeJsonApiData<NamespaceScopedMetadata, DaemonSetStatus, DaemonSetSpec>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#spec","title":"spec","text":"\u2022 spec: DaemonSetSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#status","title":"status","text":"\u2022 Optional status: DaemonSetStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#apibase","title":"apiBase","text":"\u25aa Static apiBase: string
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#kind_1","title":"kind","text":"\u25aa Static kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#namespaced","title":"namespaced","text":"\u25aa Static namespaced: boolean
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getaffinity","title":"getAffinity","text":"\u25b8 getAffinity(): undefined | Affinity
undefined | Affinity
\u25b8 getAffinityNumber(): number
number
\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_13","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_14","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_15","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getimages","title":"getImages","text":"\u25b8 getImages(): (undefined | string)[]
(undefined | string)[]
\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getnodeselectors","title":"getNodeSelectors","text":"\u25b8 getNodeSelectors(): string[]
string[]
\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getselectors","title":"getSelectors","text":"\u25b8 getSelectors(): string[]
string[]
\u25b8 getTemplateLabels(): string[]
string[]
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_29","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#gettolerations","title":"getTolerations","text":"\u25b8 getTolerations(): Toleration[]
Toleration[]
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_31","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#parameters_14","title":"Parameters","text":"Name Typedata Partial<DaemonSet>"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#returns_33","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/","title":"Main.K8sApi.Deployment","text":"@k8slens/extensions / Exports / Main / K8sApi / Deployment
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#class-deployment","title":"Class: Deployment","text":"Main.K8sApi.Deployment
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, DeploymentStatus, DeploymentSpec>\u21b3 Deployment
\u2022 new Deployment(data)
data KubeJsonApiData<NamespaceScopedMetadata, DeploymentStatus, DeploymentSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#spec","title":"spec","text":"\u2022 spec: DeploymentSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#status","title":"status","text":"\u2022 Optional status: DeploymentStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#apibase","title":"apiBase","text":"\u25aa Static apiBase: string
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#kind_1","title":"kind","text":"\u25aa Static kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#namespaced","title":"namespaced","text":"\u25aa Static namespaced: boolean
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getaffinity","title":"getAffinity","text":"\u25b8 getAffinity(): undefined | Affinity
undefined | Affinity
\u25b8 getAffinityNumber(): number
number
\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_13","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_14","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getconditions","title":"getConditions","text":"\u25b8 getConditions(activeOnly?): BaseKubeObjectCondition[]
activeOnly? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_15","title":"Returns","text":"BaseKubeObjectCondition[]
\u25b8 getConditionsText(activeOnly?): string
activeOnly? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_16","title":"Returns","text":"string
\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_17","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getnodeselectors","title":"getNodeSelectors","text":"\u25b8 getNodeSelectors(): string[]
string[]
\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getreplicas","title":"getReplicas","text":"\u25b8 getReplicas(): number
number
\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getselectors","title":"getSelectors","text":"\u25b8 getSelectors(): string[]
string[]
\u25b8 getTemplateLabels(): string[]
string[]
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_31","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#gettolerations","title":"getTolerations","text":"\u25b8 getTolerations(): Toleration[]
Toleration[]
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_15","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_33","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#parameters_16","title":"Parameters","text":"Name Typedata Partial<Deployment>"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#returns_35","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/","title":"Main.K8sApi.Endpoint","text":"@k8slens/extensions / Exports / Main / K8sApi / Endpoint
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#class-endpoint","title":"Class: Endpoint","text":"Main.K8sApi.Endpoint
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, void, void>\u21b3 Endpoint
\u2022 new Endpoint(\u00abdestructured\u00bb)
\u00abdestructured\u00bb EndpointsData"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#overrides","title":"Overrides","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#spec","title":"spec","text":"\u2022 spec: void
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#status","title":"status","text":"\u2022 Optional status: void
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#subsets","title":"subsets","text":"\u2022 Optional subsets: EndpointSubset[]
\u25aa Static apiBase: string
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_6","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_8","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_11","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#kind_1","title":"kind","text":"\u25aa Static kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#namespaced","title":"namespaced","text":"\u25aa Static namespaced: boolean
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getendpointsubsets","title":"getEndpointSubsets","text":"\u25b8 getEndpointSubsets(): Required<EndpointSubset>[]
Required<EndpointSubset>[]
\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_24","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#patch","title":"patch","text":"\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_25","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#tostring","title":"toString","text":"\u25b8 toString(): string
string
\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#parameters_14","title":"Parameters","text":"Name Typedata Partial<Endpoint>"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#returns_28","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/","title":"Main.K8sApi.HorizontalPodAutoscaler","text":"@k8slens/extensions / Exports / Main / K8sApi / HorizontalPodAutoscaler
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#class-horizontalpodautoscaler","title":"Class: HorizontalPodAutoscaler","text":"Main.K8sApi.HorizontalPodAutoscaler
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, HorizontalPodAutoscalerStatus, HorizontalPodAutoscalerSpec>\u21b3 HorizontalPodAutoscaler
\u2022 new HorizontalPodAutoscaler(data)
data KubeJsonApiData<NamespaceScopedMetadata, HorizontalPodAutoscalerStatus, HorizontalPodAutoscalerSpec>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#spec","title":"spec","text":"\u2022 spec: HorizontalPodAutoscalerSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#status","title":"status","text":"\u2022 Optional status: HorizontalPodAutoscalerStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#apibase","title":"apiBase","text":"\u25aa Static Readonly apiBase: \"/apis/autoscaling/v2/horizontalpodautoscalers\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"HorizontalPodAutoscaler\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: true
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getconditions","title":"getConditions","text":"\u25b8 getConditions(): { isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]
{ isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]
\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_14","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getcurrentmetrics","title":"getCurrentMetrics","text":"\u25b8 getCurrentMetrics(): HorizontalPodAutoscalerMetricStatus[]
HorizontalPodAutoscalerMetricStatus[]
\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getmaxpods","title":"getMaxPods","text":"\u25b8 getMaxPods(): number
number
\u25b8 getMetrics(): HorizontalPodAutoscalerMetricSpec[]
HorizontalPodAutoscalerMetricSpec[]
\u25b8 getMinPods(): number
number
\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getreadyconditions","title":"getReadyConditions","text":"\u25b8 getReadyConditions(): { isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]
{ isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: \"True\" | \"False\" | \"Unknown\" ; tooltip: string ; type: string }[]
\u25b8 getReplicas(): number
number
\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_30","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#patch","title":"patch","text":"\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_31","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#parameters_14","title":"Parameters","text":"Name Typedata Partial<HorizontalPodAutoscaler>"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#returns_33","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/","title":"Main.K8sApi.Ingress","text":"@k8slens/extensions / Exports / Main / K8sApi / Ingress
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#class-ingress","title":"Class: Ingress","text":"Main.K8sApi.Ingress
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, IngressStatus, IngressSpec>\u21b3 Ingress
\u2022 new Ingress(data)
data KubeJsonApiData<NamespaceScopedMetadata, IngressStatus, IngressSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#spec","title":"spec","text":"\u2022 spec: IngressSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#status","title":"status","text":"\u2022 Optional status: IngressStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#apibase","title":"apiBase","text":"\u25aa Static Readonly apiBase: \"/apis/networking.k8s.io/v1/ingresses\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"Ingress\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: true
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#gethosts","title":"getHosts","text":"\u25b8 getHosts(): string[]
string[]
\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getloadbalancers","title":"getLoadBalancers","text":"\u25b8 getLoadBalancers(): (undefined | string)[]
(undefined | string)[]
\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getports","title":"getPorts","text":"\u25b8 getPorts(): string
string
\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getroutes","title":"getRoutes","text":"\u25b8 getRoutes(): string[]
string[]
\u25b8 getRules(): IngressRule[]
IngressRule[]
\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getservicenameport","title":"getServiceNamePort","text":"\u25b8 getServiceNamePort(): undefined | ExtensionsBackend
undefined | ExtensionsBackend
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_29","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#patch","title":"patch","text":"\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_30","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#parameters_14","title":"Parameters","text":"Name Typedata Partial<Ingress>"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#returns_32","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.Job/","title":"Main.K8sApi.Job","text":"@k8slens/extensions / Exports / Main / K8sApi / Job
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#class-job","title":"Class: Job","text":"Main.K8sApi.Job
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, JobStatus, JobSpec>\u21b3 Job
\u2022 new Job(data)
data KubeJsonApiData<NamespaceScopedMetadata, JobStatus, JobSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Job/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#spec","title":"spec","text":"\u2022 spec: JobSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#status","title":"status","text":"\u2022 Optional status: JobStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#apibase","title":"apiBase","text":"\u25aa Static Readonly apiBase: \"/apis/batch/v1/jobs\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"Job\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: true
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Job/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Job/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getaffinity","title":"getAffinity","text":"\u25b8 getAffinity(): undefined | Affinity
undefined | Affinity
\u25b8 getAffinityNumber(): number
number
\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_13","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_14","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getcompletions","title":"getCompletions","text":"\u25b8 getCompletions(): number
number
\u25b8 getCondition(): undefined | BaseKubeObjectCondition
undefined | BaseKubeObjectCondition
\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_17","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getdesiredcompletions","title":"getDesiredCompletions","text":"\u25b8 getDesiredCompletions(): number
number
\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getimages","title":"getImages","text":"\u25b8 getImages(): (undefined | string)[]
(undefined | string)[]
\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getnodeselectors","title":"getNodeSelectors","text":"\u25b8 getNodeSelectors(): string[]
string[]
\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getparallelism","title":"getParallelism","text":"\u25b8 getParallelism(): undefined | number
undefined | number
\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getselectors","title":"getSelectors","text":"\u25b8 getSelectors(): string[]
string[]
\u25b8 getTemplateLabels(): string[]
string[]
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_33","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#gettolerations","title":"getTolerations","text":"\u25b8 getTolerations(): Toleration[]
Toleration[]
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_35","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Job/#parameters_14","title":"Parameters","text":"Name Typedata Partial<Job>"},{"location":"extensions/api/classes/Main.K8sApi.Job/#returns_37","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/","title":"Main.K8sApi.KubeEvent","text":"@k8slens/extensions / Exports / Main / K8sApi / KubeEvent
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#class-kubeevent","title":"Class: KubeEvent","text":"Main.K8sApi.KubeEvent
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#hierarchy","title":"Hierarchy","text":"KubeObject<KubeObjectMetadata<KubeObjectScope.Namespace>, void, void>\u21b3 KubeEvent
\u2022 new KubeEvent(\u00abdestructured\u00bb)
\u00abdestructured\u00bb KubeEventData"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#overrides","title":"Overrides","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#action","title":"action","text":"\u2022 Optional action: string
\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#count","title":"count","text":"\u2022 Optional count: number
\u2022 Optional eventTime: string
\u2022 Optional firstTimestamp: string
\u2022 involvedObject: Required<ObjectReference>
\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#lasttimestamp","title":"lastTimestamp","text":"\u2022 Optional lastTimestamp: string
\u2022 Optional message: string
\u2022 metadata: KubeObjectMetadata<Namespace>
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#reason","title":"reason","text":"\u2022 Optional reason: string
\u2022 Optional related: ObjectReference
\u2022 Optional reportingComponent: string
\u2022 Optional reportingInstance: string
\u2022 Optional series: EventSeries
\u2022 Optional source: EventSource
\u2022 spec: void
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#status","title":"status","text":"\u2022 Optional status: void
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type","title":"type","text":"\u2022 Optional type: string
Current supported values are: - \"Normal\" - \"Warning\"
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#apibase","title":"apiBase","text":"\u25aa Static apiBase: string
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_6","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_8","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_11","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#kind_1","title":"kind","text":"\u25aa Static kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#namespaced","title":"namespaced","text":"\u25aa Static namespaced: boolean
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getfirstseentime","title":"getFirstSeenTime","text":"\u25b8 getFirstSeenTime(): string
Deprecated
This function is not reactive to changing of time. If rendering use <ReactiveDuration /> instead
string
\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getlastseentime","title":"getLastSeenTime","text":"\u25b8 getLastSeenTime(): string
Deprecated
This function is not reactive to changing of time. If rendering use <ReactiveDuration /> instead
string
\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getsource","title":"getSource","text":"\u25b8 getSource(): string
string
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_26","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#iswarning","title":"isWarning","text":"\u25b8 isWarning(): boolean
boolean
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_28","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#parameters_14","title":"Parameters","text":"Name Typedata Partial<KubeEvent>"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#returns_30","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/","title":"Main.K8sApi.KubeObject","text":"@k8slens/extensions / Exports / Main / K8sApi / KubeObject
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#class-kubeobjectmetadata-status-spec","title":"Class: KubeObject<Metadata, Status, Spec>","text":"Main.K8sApi.KubeObject
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#hierarchy","title":"Hierarchy","text":"KubeObject\u21b3 Pod
\u21b3 Node
\u21b3 Deployment
\u21b3 DaemonSet
\u21b3 StatefulSet
\u21b3 Job
\u21b3 CronJob
\u21b3 ConfigMap
\u21b3 Secret
\u21b3 ReplicaSet
\u21b3 ResourceQuota
\u21b3 LimitRange
\u21b3 HorizontalPodAutoscaler
\u21b3 PodDisruptionBudget
\u21b3 PriorityClass
\u21b3 Service
\u21b3 Endpoint
\u21b3 Ingress
\u21b3 NetworkPolicy
\u21b3 PersistentVolume
\u21b3 PersistentVolumeClaim
\u21b3 StorageClass
\u21b3 Namespace
\u21b3 KubeEvent
\u21b3 ServiceAccount
\u21b3 Role
\u21b3 RoleBinding
\u21b3 ClusterRole
\u21b3 ClusterRoleBinding
\u21b3 CustomResourceDefinition
\u2022 new KubeObject<Metadata, Status, Spec>(data)
Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
\u2022 kind: string
\u2022 metadata: Metadata
\u2022 spec: Spec
\u2022 Optional status: Status
\u25aa Static Optional Readonly apiBase: string
\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-parameters_2","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-parameters_3","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_5","title":"Returns","text":"boolean
\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#kind_1","title":"kind","text":"\u25aa Static Optional Readonly kind: string
\u25aa Static Optional Readonly namespaced: boolean
\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_8","title":"Returns","text":"string[]
\u2022 get selfLink(): string
string
\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_10","title":"Returns","text":"void
\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_11","title":"Returns","text":"string | number
\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_12","title":"Returns","text":"string[]
\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_13","title":"Returns","text":"number
\u25b8 getFinalizers(): string[]
string[]
\u25b8 getId(): string
string
\u25b8 getLabels(): string[]
string[]
\u25b8 getName(): string
string
\u25b8 getNs(): Metadata[\"namespace\"]
Metadata[\"namespace\"]
\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: Metadata[\"namespace\"] ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: Metadata[\"namespace\"] ; uid: string }[]
\u25b8 getResourceVersion(): string
string
\u25b8 getScopedName(): string
string
\u25b8 getSearchFields(): (string | Metadata[\"namespace\"])[]
(string | Metadata[\"namespace\"])[]
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_23","title":"Returns","text":"number
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_24","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#parameters_14","title":"Parameters","text":"Name Typedata Partial<KubeObject<Metadata, Status, Spec>>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#returns_26","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
@k8slens/extensions / Exports / Main / K8sApi / KubeObjectStore
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#class-kubeobjectstorek-a-d","title":"Class: KubeObjectStore<K, A, D>","text":"Main.K8sApi.KubeObjectStore
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#type-parameters","title":"Type parameters","text":"Name TypeK extends KubeObject = KubeObject A extends InternalKubeApi<K, D> = InternalKubeApi<K, KubeJsonApiDataFor<K>> D extends KubeJsonApiDataFor<K> = KubeApiDataFrom<K, A>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<K, A, D>\u21b3 KubeObjectStore
\u2022 new KubeObjectStore<K, A, D>(api, opts?)
K extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, K> = KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> A extends KubeApi<K, D, A> = KubeApi<K, KubeJsonApiDataFor<K>> D extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, D> = KubeApiDataFrom<K, A>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#parameters","title":"Parameters","text":"Name Type api A opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#overrides","title":"Overrides","text":"InternalKubeObjectStore<K, A, D\\>.constructor
\u2022 new KubeObjectStore<K, A, D>()
Deprecated
Supply API instance through constructor
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#type-parameters_2","title":"Type parameters","text":"Name TypeK extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, K> = KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> A extends KubeApi<K, D, A> = KubeApi<K, KubeJsonApiDataFor<K>> D extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, D> = KubeApiDataFrom<K, A>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#overrides_1","title":"Overrides","text":"InternalKubeObjectStore<K, A, D\\>.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#api","title":"api","text":"\u2022 Readonly api: A
InternalKubeObjectStore.api
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
InternalKubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: K) => string
\u25b8 (item): string
item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns","title":"Returns","text":"string
InternalKubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
InternalKubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<D>>
InternalKubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
InternalKubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
InternalKubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
InternalKubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#items","title":"items","text":"\u2022 items: IObservableArray<K>
InternalKubeObjectStore.items
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
InternalKubeObjectStore.limit
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
InternalKubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#context","title":"context","text":"\u25aa Static Readonly context: Object
Deprecated
This is no longer used and shouldn't have been every really used
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#type-declaration_1","title":"Type declaration","text":"Name Typeget () => ClusterContext set (ctx: ClusterContext) => void"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#context_1","title":"context","text":"\u2022 get context(): ClusterContext
ClusterContext
\u2022 get contextItems(): K[]
K[]
InternalKubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
InternalKubeObjectStore.query
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
InternalKubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<K, void, undefined>
Generator<K, void, undefined>
InternalKubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_6","title":"Returns","text":"void
InternalKubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<K>
params Object params.name string params.namespace? string data? PartialDeep<K, {}>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_7","title":"Returns","text":"Promise<K>
InternalKubeObjectStore.create
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | K>
params Object params.name string params.namespace? string data? PartialDeep<K, {}>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_8","title":"Returns","text":"Promise<null | K>
InternalKubeObjectStore.createItem
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): K[]
items K[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_9","title":"Returns","text":"K[]
InternalKubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): K[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_10","title":"Returns","text":"K[]
InternalKubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | K
id string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_11","title":"Returns","text":"undefined | K
InternalKubeObjectStore.getById
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): K[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_12","title":"Returns","text":"K[]
InternalKubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | K
name string namespace? string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_13","title":"Returns","text":"undefined | K
InternalKubeObjectStore.getByName
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | K
path string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_14","title":"Returns","text":"undefined | K
InternalKubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_15","title":"Returns","text":"number
InternalKubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getitems","title":"getItems","text":"\u25b8 getItems(): K[]
K[]
InternalKubeObjectStore.getItems
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
InternalKubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_18","title":"Returns","text":"boolean
InternalKubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? K[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_19","title":"Returns","text":"boolean
InternalKubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#load","title":"load","text":"\u25b8 load(params): Promise<K>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_20","title":"Returns","text":"Promise<K>
InternalKubeObjectStore.load
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | K[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_21","title":"Returns","text":"Promise<undefined | K[]>
InternalKubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<K>
resourcePath string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_22","title":"Returns","text":"Promise<K>
InternalKubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | K>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_23","title":"Returns","text":"Promise<null | K>
InternalKubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<K[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_24","title":"Returns","text":"Promise<K[]>
InternalKubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): K[]
partialItems K[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_25","title":"Returns","text":"K[]
InternalKubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<K>
item K patch Patch"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_26","title":"Returns","text":"Promise<K>
InternalKubeObjectStore.patch
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): K[]
items K[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_27","title":"Returns","text":"K[]
InternalKubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | K[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_28","title":"Returns","text":"Promise<undefined | K[]>
InternalKubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_29","title":"Returns","text":"Promise<void>
InternalKubeObjectStore.remove
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item K request () => Promise<any>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_30","title":"Returns","text":"Promise<void>
InternalKubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items K[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_31","title":"Returns","text":"Promise<void>
InternalKubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
InternalKubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
InternalKubeObjectStore.reset
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_34","title":"Returns","text":"void
InternalKubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
InternalKubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#select","title":"select","text":"\u25b8 select(item): void
item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_36","title":"Returns","text":"void
InternalKubeObjectStore.select
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): K[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? K[] the items to be sorted (default: the current items in this store) sorting? (item: K) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_37","title":"Returns","text":"K[]
InternalKubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_38","title":"Returns","text":"Disposer
InternalKubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_39","title":"Returns","text":"void
InternalKubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? K[]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_40","title":"Returns","text":"void
InternalKubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item K"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_41","title":"Returns","text":"void
InternalKubeObjectStore.unselect
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<K>
item K data PartialDeep<K, {}>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_42","title":"Returns","text":"Promise<K>
InternalKubeObjectStore.update
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
InternalKubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<K>
item K request () => Promise<K>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#returns_44","title":"Returns","text":"Promise<K>
InternalKubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/","title":"Main.K8sApi.KubeStatus","text":"@k8slens/extensions / Exports / Main / K8sApi / KubeStatus
"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#class-kubestatus","title":"Class: KubeStatus","text":"Main.K8sApi.KubeStatus
"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#constructors","title":"Constructors","text":"\u2022 new KubeStatus(data)
data KubeStatusData"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#apiversion","title":"apiVersion","text":"\u2022 Readonly apiVersion: string
\u2022 Readonly code: number
\u2022 Readonly kind: \"Status\"
\u2022 Readonly message: string
\u2022 Readonly reason: string
\u2022 Readonly status: string
\u25b8 getExplanation(): string
string
@k8slens/extensions / Exports / Main / K8sApi / LimitRange
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#class-limitrange","title":"Class: LimitRange","text":"Main.K8sApi.LimitRange
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, void, LimitRangeSpec>\u21b3 LimitRange
\u2022 new LimitRange(data)
data KubeJsonApiData<NamespaceScopedMetadata, void, LimitRangeSpec>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#spec","title":"spec","text":"\u2022 spec: LimitRangeSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#status","title":"status","text":"\u2022 Optional status: void
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#apibase","title":"apiBase","text":"\u25aa Static Readonly apiBase: \"/api/v1/limitranges\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"LimitRange\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: true
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getcontainerlimits","title":"getContainerLimits","text":"\u25b8 getContainerLimits(): LimitRangeItem[]
LimitRangeItem[]
\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_14","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getpvclimits","title":"getPVCLimits","text":"\u25b8 getPVCLimits(): LimitRangeItem[]
LimitRangeItem[]
\u25b8 getPodLimits(): LimitRangeItem[]
LimitRangeItem[]
\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_26","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#patch","title":"patch","text":"\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_27","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#parameters_14","title":"Parameters","text":"Name Typedata Partial<LimitRange>"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#returns_29","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/","title":"Main.K8sApi.Namespace","text":"@k8slens/extensions / Exports / Main / K8sApi / Namespace
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#class-namespace","title":"Class: Namespace","text":"Main.K8sApi.Namespace
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#hierarchy","title":"Hierarchy","text":"KubeObject<ClusterScopedMetadata, NamespaceStatus, NamespaceSpec>\u21b3 Namespace
\u2022 new Namespace(data)
data KubeJsonApiData<ClusterScopedMetadata, NamespaceStatus, NamespaceSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#metadata","title":"metadata","text":"\u2022 metadata: ClusterScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#spec","title":"spec","text":"\u2022 spec: NamespaceSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#status","title":"status","text":"\u2022 Optional status: NamespaceStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#apibase","title":"apiBase","text":"\u25aa Static Readonly apiBase: \"/api/v1/namespaces\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"Namespace\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: false
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getns","title":"getNs","text":"\u25b8 getNs(): undefined
undefined
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): (undefined | string)[]
(undefined | string)[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getstatus","title":"getStatus","text":"\u25b8 getStatus(): string
string
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_24","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#ischildof","title":"isChildOf","text":"\u25b8 isChildOf(parentName): undefined | string
parentName string"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_25","title":"Returns","text":"undefined | string
\u25b8 isControlledByHNC(): boolean
boolean
\u25b8 isSubnamespace(): undefined | string
undefined | string
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_14","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_28","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#parameters_15","title":"Parameters","text":"Name Typedata Partial<Namespace>"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#returns_30","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/","title":"Main.K8sApi.NetworkPolicy","text":"@k8slens/extensions / Exports / Main / K8sApi / NetworkPolicy
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#class-networkpolicy","title":"Class: NetworkPolicy","text":"Main.K8sApi.NetworkPolicy
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, void, NetworkPolicySpec>\u21b3 NetworkPolicy
\u2022 new NetworkPolicy(data)
data KubeJsonApiData<NamespaceScopedMetadata, void, NetworkPolicySpec>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#spec","title":"spec","text":"\u2022 spec: NetworkPolicySpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#status","title":"status","text":"\u2022 Optional status: void
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#apibase","title":"apiBase","text":"\u25aa Static Readonly apiBase: \"/apis/networking.k8s.io/v1/networkpolicies\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"NetworkPolicy\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: true
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getmatchlabels","title":"getMatchLabels","text":"\u25b8 getMatchLabels(): string[]
string[]
\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_24","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#gettypes","title":"getTypes","text":"\u25b8 getTypes(): string[]
string[]
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_26","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#parameters_14","title":"Parameters","text":"Name Typedata Partial<NetworkPolicy>"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#returns_28","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.Node/","title":"Main.K8sApi.Node","text":"@k8slens/extensions / Exports / Main / K8sApi / Node
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#class-node","title":"Class: Node","text":"Main.K8sApi.Node
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#hierarchy","title":"Hierarchy","text":"KubeObject<ClusterScopedMetadata, NodeStatus, NodeSpec>\u21b3 Node
\u2022 new Node(data)
data KubeJsonApiData<ClusterScopedMetadata, NodeStatus, NodeSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Node/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#metadata","title":"metadata","text":"\u2022 metadata: ClusterScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#spec","title":"spec","text":"\u2022 spec: NodeSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#status","title":"status","text":"\u2022 Optional status: NodeStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#apibase","title":"apiBase","text":"\u25aa Static Readonly apiBase: \"/api/v1/nodes\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"Node\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: false
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Node/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Node/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getactiveconditions","title":"getActiveConditions","text":"\u25b8 getActiveConditions(): NodeCondition[]
NodeCondition[]
\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_12","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_13","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getconditions","title":"getConditions","text":"\u25b8 getConditions(): NodeCondition[]
NodeCondition[]
\u25b8 getCpuCapacity(): undefined | number
undefined | number
\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_16","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getkubeletversion","title":"getKubeletVersion","text":"\u25b8 getKubeletVersion(): string
string
\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getmemorycapacity","title":"getMemoryCapacity","text":"\u25b8 getMemoryCapacity(): number
number
\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getnodeconditiontext","title":"getNodeConditionText","text":"\u25b8 getNodeConditionText(): string
Returns the concatination of all current condition types which have a status of \"True\"
string
\u25b8 getNs(): undefined
undefined
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getoperatingsystem","title":"getOperatingSystem","text":"\u25b8 getOperatingSystem(): string
string
\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getrolelabelitems","title":"getRoleLabelItems","text":"\u25b8 getRoleLabelItems(): string[]
string[]
\u25b8 getRoleLabels(): string
string
\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): (undefined | string)[]
(undefined | string)[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#gettaints","title":"getTaints","text":"\u25b8 getTaints(): NodeTaint[]
NodeTaint[]
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_33","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getwarningconditions","title":"getWarningConditions","text":"\u25b8 getWarningConditions(): NodeCondition[]
NodeCondition[]
\u25b8 isMasterNode(): boolean
boolean
\u25b8 isUnschedulable(): undefined | boolean
undefined | boolean
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_37","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Node/#parameters_14","title":"Parameters","text":"Name Typedata Partial<Node>"},{"location":"extensions/api/classes/Main.K8sApi.Node/#returns_39","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/","title":"Main.K8sApi.PersistentVolume","text":"@k8slens/extensions / Exports / Main / K8sApi / PersistentVolume
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#class-persistentvolume","title":"Class: PersistentVolume","text":"Main.K8sApi.PersistentVolume
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#hierarchy","title":"Hierarchy","text":"KubeObject<ClusterScopedMetadata, PersistentVolumeStatus, PersistentVolumeSpec>\u21b3 PersistentVolume
\u2022 new PersistentVolume(data)
data KubeJsonApiData<ClusterScopedMetadata, PersistentVolumeStatus, PersistentVolumeSpec>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#metadata","title":"metadata","text":"\u2022 metadata: ClusterScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#spec","title":"spec","text":"\u2022 spec: PersistentVolumeSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#status","title":"status","text":"\u2022 Optional status: PersistentVolumeStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#apibase","title":"apiBase","text":"\u25aa Static apiBase: string
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#kind_1","title":"kind","text":"\u25aa Static kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#namespaced","title":"namespaced","text":"\u25aa Static namespaced: boolean
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getcapacity","title":"getCapacity","text":"\u25b8 getCapacity(inBytes?): string | number
inBytes? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_13","title":"Returns","text":"string | number
\u25b8 getClaimRefName(): string
string
\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_15","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getns","title":"getNs","text":"\u25b8 getNs(): undefined
undefined
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): (undefined | string)[]
(undefined | string)[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getstatus","title":"getStatus","text":"\u25b8 getStatus(): string
string
\u25b8 getStorageClass(): string
string
\u25b8 getStorageClassName(): string
string
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_28","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#patch","title":"patch","text":"\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_14","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_29","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#parameters_15","title":"Parameters","text":"Name Typedata Partial<PersistentVolume>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#returns_31","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/","title":"Main.K8sApi.PersistentVolumeClaim","text":"@k8slens/extensions / Exports / Main / K8sApi / PersistentVolumeClaim
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#class-persistentvolumeclaim","title":"Class: PersistentVolumeClaim","text":"Main.K8sApi.PersistentVolumeClaim
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, PersistentVolumeClaimStatus, PersistentVolumeClaimSpec>\u21b3 PersistentVolumeClaim
\u2022 new PersistentVolumeClaim(data)
data KubeJsonApiData<NamespaceScopedMetadata, PersistentVolumeClaimStatus, PersistentVolumeClaimSpec>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#spec","title":"spec","text":"\u2022 spec: PersistentVolumeClaimSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#status","title":"status","text":"\u2022 Optional status: PersistentVolumeClaimStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#apibase","title":"apiBase","text":"\u25aa Static Readonly apiBase: \"/api/v1/persistentvolumeclaims\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"PersistentVolumeClaim\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: true
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getmatchexpressions","title":"getMatchExpressions","text":"\u25b8 getMatchExpressions(): LabelMatchExpression[]
LabelMatchExpression[]
\u25b8 getMatchLabels(): string[]
string[]
\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getpods","title":"getPods","text":"\u25b8 getPods(pods): Pod[]
pods Pod[]"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_22","title":"Returns","text":"Pod[]
\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getstatus","title":"getStatus","text":"\u25b8 getStatus(): string
string
\u25b8 getStorage(): string
string
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_28","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#patch","title":"patch","text":"\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_14","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_29","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#parameters_15","title":"Parameters","text":"Name Typedata Partial<PersistentVolumeClaim>"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#returns_31","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/","title":"Main.K8sApi.Pod","text":"@k8slens/extensions / Exports / Main / K8sApi / Pod
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#class-pod","title":"Class: Pod","text":"Main.K8sApi.Pod
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, PodStatus, PodSpec>\u21b3 Pod
\u2022 new Pod(data)
data KubeJsonApiData<NamespaceScopedMetadata, PodStatus, PodSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Pod/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#spec","title":"spec","text":"\u2022 spec: PodSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#status","title":"status","text":"\u2022 Optional status: PodStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#apibase","title":"apiBase","text":"\u25aa Static apiBase: string
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#kind_1","title":"kind","text":"\u25aa Static kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#namespaced","title":"namespaced","text":"\u25aa Static namespaced: boolean
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Pod/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Pod/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getaffinity","title":"getAffinity","text":"\u25b8 getAffinity(): Affinity
Affinity
\u25b8 getAffinityNumber(): number
number
\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_13","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getallcontainers","title":"getAllContainers","text":"\u25b8 getAllContainers(): IPodContainer[]
IPodContainer[]
\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_15","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getconditions","title":"getConditions","text":"\u25b8 getConditions(): PodCondition[]
PodCondition[]
\u25b8 getContainerStatuses(includeInitContainers?): IPodContainerStatus[]
includeInitContainers? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_17","title":"Returns","text":"IPodContainerStatus[]
\u25b8 getContainers(): IPodContainer[]
IPodContainer[]
\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_19","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getips","title":"getIPs","text":"\u25b8 getIPs(): string[]
string[]
\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getinitcontainers","title":"getInitContainers","text":"\u25b8 getInitContainers(): IPodContainer[]
IPodContainer[]
\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getlivenessprobe","title":"getLivenessProbe","text":"\u25b8 getLivenessProbe(container): string[]
container IPodContainer"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_25","title":"Returns","text":"string[]
\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getnodename","title":"getNodeName","text":"\u25b8 getNodeName(): undefined | string
undefined | string
\u25b8 getNodeSelectors(): string[]
string[]
\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getpriorityclassname","title":"getPriorityClassName","text":"\u25b8 getPriorityClassName(): string
string
\u25b8 getQosClass(): string
string
\u25b8 getReadinessProbe(container): string[]
container IPodContainer"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_33","title":"Returns","text":"string[]
\u25b8 getReason(): string
string
\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getrestartscount","title":"getRestartsCount","text":"\u25b8 getRestartsCount(): number
number
\u25b8 getRunningContainers(): IPodContainer[]
IPodContainer[]
\u25b8 getRuntimeClassName(): string
string
\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getsecrets","title":"getSecrets","text":"\u25b8 getSecrets(): string[]
string[]
\u25b8 getSelectedNodeOs(): undefined | string
undefined | string
\u25b8 getServiceAccountName(): string
string
\u25b8 getStartupProbe(container): string[]
container IPodContainer"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_44","title":"Returns","text":"string[]
\u25b8 getStatus(): PodStatusPhase
PodStatusPhase
\u25b8 getStatusMessage(): string
string
\u25b8 getStatusPhase(): undefined | string
undefined | string
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_48","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#gettolerations","title":"getTolerations","text":"\u25b8 getTolerations(): Toleration[]
Toleration[]
\u25b8 getVolumes(): PodSpecVolume[]
PodSpecVolume[]
\u25b8 hasIssues(): boolean
boolean
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_17","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_52","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#parameters_18","title":"Parameters","text":"Name Typedata Partial<Pod>"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#returns_54","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/","title":"Main.K8sApi.PodDisruptionBudget","text":"@k8slens/extensions / Exports / Main / K8sApi / PodDisruptionBudget
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#class-poddisruptionbudget","title":"Class: PodDisruptionBudget","text":"Main.K8sApi.PodDisruptionBudget
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, PodDisruptionBudgetStatus, PodDisruptionBudgetSpec>\u21b3 PodDisruptionBudget
\u2022 new PodDisruptionBudget(data)
data KubeJsonApiData<NamespaceScopedMetadata, PodDisruptionBudgetStatus, PodDisruptionBudgetSpec>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#spec","title":"spec","text":"\u2022 spec: PodDisruptionBudgetSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#status","title":"status","text":"\u2022 Optional status: PodDisruptionBudgetStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#apibase","title":"apiBase","text":"\u25aa Static Readonly apiBase: \"/apis/policy/v1beta1/poddisruptionbudgets\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"PodDisruptionBudget\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: true
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getcurrenthealthy","title":"getCurrentHealthy","text":"\u25b8 getCurrentHealthy(): number
number
\u25b8 getDesiredHealthy(): number
number
\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getmaxunavailable","title":"getMaxUnavailable","text":"\u25b8 getMaxUnavailable(): string | number
string | number
\u25b8 getMinAvailable(): string | number
string | number
\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getselectors","title":"getSelectors","text":"\u25b8 getSelectors(): string[]
string[]
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_28","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#patch","title":"patch","text":"\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_29","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#parameters_14","title":"Parameters","text":"Name Typedata Partial<PodDisruptionBudget>"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#returns_31","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/","title":"Main.K8sApi.PriorityClass","text":"@k8slens/extensions / Exports / Main / K8sApi / PriorityClass
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#class-priorityclass","title":"Class: PriorityClass","text":"Main.K8sApi.PriorityClass
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#hierarchy","title":"Hierarchy","text":"KubeObject<ClusterScopedMetadata, void, void>\u21b3 PriorityClass
\u2022 new PriorityClass(\u00abdestructured\u00bb)
\u00abdestructured\u00bb PriorityClassData"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#overrides","title":"Overrides","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#description","title":"description","text":"\u2022 Optional description: string
\u2022 Optional globalDefault: boolean
\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#metadata","title":"metadata","text":"\u2022 metadata: ClusterScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#preemptionpolicy","title":"preemptionPolicy","text":"\u2022 Optional preemptionPolicy: PreemptionPolicy
\u2022 spec: void
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#status","title":"status","text":"\u2022 Optional status: void
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#value","title":"value","text":"\u2022 Optional value: number
\u25aa Static Readonly apiBase: \"/apis/scheduling.k8s.io/v1/priorityclasses\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_6","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_8","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_11","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"PriorityClass\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: false
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getdescription","title":"getDescription","text":"\u25b8 getDescription(): string
string
\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getglobaldefault","title":"getGlobalDefault","text":"\u25b8 getGlobalDefault(): string
string
\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getns","title":"getNs","text":"\u25b8 getNs(): undefined
undefined
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getpreemptionpolicy","title":"getPreemptionPolicy","text":"\u25b8 getPreemptionPolicy(): PreemptionPolicy
PreemptionPolicy
\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): (undefined | string)[]
(undefined | string)[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_26","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getvalue","title":"getValue","text":"\u25b8 getValue(): undefined | number
undefined | number
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_28","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#parameters_14","title":"Parameters","text":"Name Typedata Partial<PriorityClass>"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#returns_30","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/","title":"Main.K8sApi.ReplicaSet","text":"@k8slens/extensions / Exports / Main / K8sApi / ReplicaSet
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#class-replicaset","title":"Class: ReplicaSet","text":"Main.K8sApi.ReplicaSet
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, ReplicaSetStatus, ReplicaSetSpec>\u21b3 ReplicaSet
\u2022 new ReplicaSet(data)
data KubeJsonApiData<NamespaceScopedMetadata, ReplicaSetStatus, ReplicaSetSpec>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#spec","title":"spec","text":"\u2022 spec: ReplicaSetSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#status","title":"status","text":"\u2022 Optional status: ReplicaSetStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#apibase","title":"apiBase","text":"\u25aa Static apiBase: string
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#kind_1","title":"kind","text":"\u25aa Static kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#namespaced","title":"namespaced","text":"\u25aa Static namespaced: boolean
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getaffinity","title":"getAffinity","text":"\u25b8 getAffinity(): undefined | Affinity
undefined | Affinity
\u25b8 getAffinityNumber(): number
number
\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_13","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_14","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_15","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getcurrent","title":"getCurrent","text":"\u25b8 getCurrent(): number
number
\u25b8 getDesired(): number
number
\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getimages","title":"getImages","text":"\u25b8 getImages(): (undefined | string)[]
(undefined | string)[]
\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getnodeselectors","title":"getNodeSelectors","text":"\u25b8 getNodeSelectors(): string[]
string[]
\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getready","title":"getReady","text":"\u25b8 getReady(): number
number
\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getselectors","title":"getSelectors","text":"\u25b8 getSelectors(): string[]
string[]
\u25b8 getTemplateLabels(): string[]
string[]
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_32","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#gettolerations","title":"getTolerations","text":"\u25b8 getTolerations(): Toleration[]
Toleration[]
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_34","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#parameters_14","title":"Parameters","text":"Name Typedata Partial<ReplicaSet>"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#returns_36","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/","title":"Main.K8sApi.ResourceQuota","text":"@k8slens/extensions / Exports / Main / K8sApi / ResourceQuota
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#class-resourcequota","title":"Class: ResourceQuota","text":"Main.K8sApi.ResourceQuota
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, ResourceQuotaStatus, ResourceQuotaSpec>\u21b3 ResourceQuota
\u2022 new ResourceQuota(data)
data KubeJsonApiData<NamespaceScopedMetadata, ResourceQuotaStatus, ResourceQuotaSpec>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#spec","title":"spec","text":"\u2022 spec: ResourceQuotaSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#status","title":"status","text":"\u2022 Optional status: ResourceQuotaStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#apibase","title":"apiBase","text":"\u25aa Static Readonly apiBase: \"/api/v1/resourcequotas\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"ResourceQuota\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: true
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getscopeselector","title":"getScopeSelector","text":"\u25b8 getScopeSelector(): { operator: string ; scopeName: string ; values: string[] }[]
{ operator: string ; scopeName: string ; values: string[] }[]
\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_24","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#patch","title":"patch","text":"\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_25","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#parameters_14","title":"Parameters","text":"Name Typedata Partial<ResourceQuota>"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#returns_27","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/","title":"Main.K8sApi.ResourceStack","text":"@k8slens/extensions / Exports / Main / K8sApi / ResourceStack
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#class-resourcestack","title":"Class: ResourceStack","text":"Main.K8sApi.ResourceStack
Deprecated
Switch to using Common.createResourceStack instead
ResourceApplyingStack\u2022 new ResourceStack(cluster, name)
cluster KubernetesCluster<KubernetesClusterMetadata, KubernetesClusterStatus, KubernetesClusterSpec> name string"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#kubectlapplyfolder","title":"kubectlApplyFolder","text":"\u25b8 kubectlApplyFolder(folderPath, templateContext?, extraArgs?): Promise<string>
folderPath string templateContext? any extraArgs? string[]"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#returns","title":"Returns","text":"Promise<string>
ResourceApplyingStack.kubectlApplyFolder
"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#kubectldeletefolder","title":"kubectlDeleteFolder","text":"\u25b8 kubectlDeleteFolder(folderPath, templateContext?, extraArgs?): Promise<string>
folderPath string templateContext? any extraArgs? string[]"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#returns_1","title":"Returns","text":"Promise<string>
ResourceApplyingStack.kubectlDeleteFolder
"},{"location":"extensions/api/classes/Main.K8sApi.Role/","title":"Main.K8sApi.Role","text":"@k8slens/extensions / Exports / Main / K8sApi / Role
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#class-role","title":"Class: Role","text":"Main.K8sApi.Role
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, void, void>\u21b3 Role
\u2022 new Role(\u00abdestructured\u00bb)
\u00abdestructured\u00bb RoleData"},{"location":"extensions/api/classes/Main.K8sApi.Role/#overrides","title":"Overrides","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Role/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#rules","title":"rules","text":"\u2022 Optional rules: PolicyRule[]
\u2022 spec: void
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#status","title":"status","text":"\u2022 Optional status: void
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#apibase","title":"apiBase","text":"\u25aa Static Readonly apiBase: \"/apis/rbac.authorization.k8s.io/v1/roles\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_6","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_8","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_11","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"Role\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: true
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Role/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Role/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getrules","title":"getRules","text":"\u25b8 getRules(): PolicyRule[]
PolicyRule[]
\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_24","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#patch","title":"patch","text":"\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_25","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Role/#parameters_14","title":"Parameters","text":"Name Typedata Partial<Role>"},{"location":"extensions/api/classes/Main.K8sApi.Role/#returns_27","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/","title":"Main.K8sApi.RoleBinding","text":"@k8slens/extensions / Exports / Main / K8sApi / RoleBinding
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#class-rolebinding","title":"Class: RoleBinding","text":"Main.K8sApi.RoleBinding
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, void, void>\u21b3 RoleBinding
\u2022 new RoleBinding(\u00abdestructured\u00bb)
\u00abdestructured\u00bb RoleBindingData"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#overrides","title":"Overrides","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#roleref","title":"roleRef","text":"\u2022 roleRef: RoleRef
\u2022 spec: void
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#status","title":"status","text":"\u2022 Optional status: void
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#subjects","title":"subjects","text":"\u2022 Optional subjects: Subject[]
\u25aa Static Readonly apiBase: \"/apis/rbac.authorization.k8s.io/v1/rolebindings\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_6","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_8","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_11","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"RoleBinding\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: true
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getsubjectnames","title":"getSubjectNames","text":"\u25b8 getSubjectNames(): string
string
\u25b8 getSubjects(): Subject[]
Subject[]
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_25","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#patch","title":"patch","text":"\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_26","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#parameters_14","title":"Parameters","text":"Name Typedata Partial<RoleBinding>"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#returns_28","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/","title":"Main.K8sApi.Secret","text":"@k8slens/extensions / Exports / Main / K8sApi / Secret
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#class-secret","title":"Class: Secret","text":"Main.K8sApi.Secret
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, void, void>\u21b3 Secret
\u2022 new Secret(\u00abdestructured\u00bb)
\u00abdestructured\u00bb SecretData"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#overrides","title":"Overrides","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Secret/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#data","title":"data","text":"\u2022 data: Partial<Record<string, string>>
\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#spec","title":"spec","text":"\u2022 spec: void
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#status","title":"status","text":"\u2022 Optional status: void
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type","title":"type","text":"\u2022 type: SecretType
\u25aa Static Readonly apiBase: \"/api/v1/secrets\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_6","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_8","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_11","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"Secret\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: true
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Secret/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Secret/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getkeys","title":"getKeys","text":"\u25b8 getKeys(): string[]
string[]
\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_24","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#gettoken","title":"getToken","text":"\u25b8 getToken(): undefined | string
undefined | string
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_26","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#parameters_14","title":"Parameters","text":"Name Typedata Partial<Secret>"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#returns_28","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.Service/","title":"Main.K8sApi.Service","text":"@k8slens/extensions / Exports / Main / K8sApi / Service
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#class-service","title":"Class: Service","text":"Main.K8sApi.Service
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, ServiceStatus, ServiceSpec>\u21b3 Service
\u2022 new Service(data)
data KubeJsonApiData<NamespaceScopedMetadata, ServiceStatus, ServiceSpec>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.Service/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#spec","title":"spec","text":"\u2022 spec: ServiceSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#status","title":"status","text":"\u2022 Optional status: ServiceStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#apibase","title":"apiBase","text":"\u25aa Static Readonly apiBase: \"/api/v1/services\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"Service\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: true
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.Service/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.Service/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getclusterip","title":"getClusterIp","text":"\u25b8 getClusterIp(): string
string
\u25b8 getClusterIps(): string[]
string[]
\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_15","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getexternalips","title":"getExternalIps","text":"\u25b8 getExternalIps(): (undefined | string)[]
(undefined | string)[]
\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getipfamilies","title":"getIpFamilies","text":"\u25b8 getIpFamilies(): string[]
string[]
\u25b8 getIpFamilyPolicy(): string
string
\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getloadbalancer","title":"getLoadBalancer","text":"\u25b8 getLoadBalancer(): undefined | { ingress?: { hostname?: string ; ip?: string }[] }
undefined | { ingress?: { hostname?: string ; ip?: string }[] }
\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getports","title":"getPorts","text":"\u25b8 getPorts(): ServicePort[]
ServicePort[]
\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getselector","title":"getSelector","text":"\u25b8 getSelector(): string[]
string[]
\u25b8 getStatus(): \"Active\" | \"Pending\"
\"Active\" | \"Pending\"
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_32","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#gettype","title":"getType","text":"\u25b8 getType(): string
string
\u25b8 isActive(): boolean
boolean
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_35","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.Service/#parameters_14","title":"Parameters","text":"Name Typedata Partial<Service>"},{"location":"extensions/api/classes/Main.K8sApi.Service/#returns_37","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/","title":"Main.K8sApi.ServiceAccount","text":"@k8slens/extensions / Exports / Main / K8sApi / ServiceAccount
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#class-serviceaccount","title":"Class: ServiceAccount","text":"Main.K8sApi.ServiceAccount
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, void, void>\u21b3 ServiceAccount
\u2022 new ServiceAccount(\u00abdestructured\u00bb)
\u00abdestructured\u00bb ServiceAccountData"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#overrides","title":"Overrides","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#automountserviceaccounttoken","title":"automountServiceAccountToken","text":"\u2022 Optional automountServiceAccountToken: boolean
\u2022 Optional imagePullSecrets: LocalObjectReference[]
\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#secrets","title":"secrets","text":"\u2022 Optional secrets: ObjectReference[]
\u2022 spec: void
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#status","title":"status","text":"\u2022 Optional status: void
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#apibase","title":"apiBase","text":"\u25aa Static Readonly apiBase: \"/api/v1/serviceaccounts\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_6","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_8","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_11","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"ServiceAccount\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: true
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getimagepullsecrets","title":"getImagePullSecrets","text":"\u25b8 getImagePullSecrets(): LocalObjectReference[]
LocalObjectReference[]
\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getns","title":"getNs","text":"\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getresourceversion","title":"getResourceVersion","text":"\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getsecrets","title":"getSecrets","text":"\u25b8 getSecrets(): ObjectReference[]
ObjectReference[]
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_25","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#patch","title":"patch","text":"\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_26","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#parameters_14","title":"Parameters","text":"Name Typedata Partial<ServiceAccount>"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#returns_28","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/","title":"Main.K8sApi.StatefulSet","text":"@k8slens/extensions / Exports / Main / K8sApi / StatefulSet
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#class-statefulset","title":"Class: StatefulSet","text":"Main.K8sApi.StatefulSet
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#hierarchy","title":"Hierarchy","text":"KubeObject<NamespaceScopedMetadata, StatefulSetStatus, StatefulSetSpec>\u21b3 StatefulSet
\u2022 new StatefulSet(data)
data KubeJsonApiData<NamespaceScopedMetadata, StatefulSetStatus, StatefulSetSpec>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from","title":"Inherited from","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#apiversion","title":"apiVersion","text":"\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#metadata","title":"metadata","text":"\u2022 metadata: NamespaceScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#spec","title":"spec","text":"\u2022 spec: StatefulSetSpec
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#status","title":"status","text":"\u2022 Optional status: StatefulSetStatus
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#apibase","title":"apiBase","text":"\u25aa Static Readonly apiBase: \"/apis/apps/v1/statefulsets\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_1","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_2","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_3","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_8","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_4","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_10","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_6","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_7","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#inherited-from_13","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"StatefulSet\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: true
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_9","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_10","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getaffinity","title":"getAffinity","text":"\u25b8 getAffinity(): Affinity
Affinity
\u25b8 getAffinityNumber(): number
number
\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_11","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_13","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_14","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_15","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getimages","title":"getImages","text":"\u25b8 getImages(): (undefined | string)[]
(undefined | string)[]
\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getnodeselectors","title":"getNodeSelectors","text":"\u25b8 getNodeSelectors(): string[]
string[]
\u25b8 getNs(): string
string
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getreplicas","title":"getReplicas","text":"\u25b8 getReplicas(): number
number
\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): string[]
string[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getselectors","title":"getSelectors","text":"\u25b8 getSelectors(): string[]
string[]
\u25b8 getTemplateLabels(): string[]
string[]
\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_30","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#gettolerations","title":"getTolerations","text":"\u25b8 getTolerations(): Toleration[]
Toleration[]
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_13","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_32","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#parameters_14","title":"Parameters","text":"Name Typedata Partial<StatefulSet>"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#returns_34","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/","title":"Main.K8sApi.StorageClass","text":"@k8slens/extensions / Exports / Main / K8sApi / StorageClass
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#class-storageclass","title":"Class: StorageClass","text":"Main.K8sApi.StorageClass
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#hierarchy","title":"Hierarchy","text":"KubeObject<ClusterScopedMetadata, void, void>\u21b3 StorageClass
\u2022 new StorageClass(\u00abdestructured\u00bb)
\u00abdestructured\u00bb StorageClassData"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#overrides","title":"Overrides","text":"KubeObject.constructor
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#allowvolumeexpansion","title":"allowVolumeExpansion","text":"\u2022 Optional allowVolumeExpansion: boolean
\u2022 allowedTopologies: TopologySelectorTerm[]
\u2022 apiVersion: string
KubeObject.apiVersion
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#kind","title":"kind","text":"\u2022 kind: string
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#metadata","title":"metadata","text":"\u2022 metadata: ClusterScopedMetadata
KubeObject.metadata
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#mountoptions","title":"mountOptions","text":"\u2022 mountOptions: string[]
\u2022 parameters: Partial<Record<string, string>>
\u2022 provisioner: string
\u2022 reclaimPolicy: string
\u2022 spec: void
KubeObject.spec
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#status","title":"status","text":"\u2022 Optional status: void
KubeObject.status
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#volumebindingmode","title":"volumeBindingMode","text":"\u2022 Optional volumeBindingMode: string
\u25aa Static Readonly apiBase: \"/apis/storage.k8s.io/v1/storageclasses\"
KubeObject.apiBase
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#create","title":"create","text":"\u25aa Static create: <Metadata, Status, Spec>(data: KubeJsonApiData<Metadata, Status, Spec>) => KubeObject<Metadata, Status, Spec>
\u25b8 <Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope> Status unknown Spec unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_2","title":"Parameters","text":"Name Type data KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns","title":"Returns","text":"KubeObject<Metadata, Status, Spec>
KubeObject.create
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isjsonapidata","title":"isJsonApiData","text":"\u25aa Static isJsonApiData: (object: unknown) => object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
\u25b8 (object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_3","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_1","title":"Returns","text":"object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_6","title":"Inherited from","text":"KubeObject.isJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isjsonapidatalist","title":"isJsonApiDataList","text":"\u25aa Static isJsonApiDataList: (object: unknown, verifyItem: (val: unknown) => val is T) => object is KubeJsonApiDataList<T>"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-declaration_2","title":"Type declaration","text":"
\u25b8 <T>(object, verifyItem): object is KubeJsonApiDataList<T>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#type-parameters_1","title":"Type parameters","text":"NameT"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_4","title":"Parameters","text":"Name Type object unknown verifyItem (val: unknown) => val is T"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_2","title":"Returns","text":"object is KubeJsonApiDataList<T>
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_7","title":"Inherited from","text":"KubeObject.isJsonApiDataList
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"\u25aa Static isKubeJsonApiListMetadata: (object: unknown) => object is KubeJsonApiListMetadata
\u25b8 (object): object is KubeJsonApiListMetadata
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_5","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_3","title":"Returns","text":"object is KubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_8","title":"Inherited from","text":"KubeObject.isKubeJsonApiListMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"\u25aa Static isKubeJsonApiMetadata: (object: unknown) => object is KubeJsonApiObjectMetadata<KubeObjectScope>
\u25b8 (object): object is KubeJsonApiObjectMetadata<KubeObjectScope>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_6","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_4","title":"Returns","text":"object is KubeJsonApiObjectMetadata<KubeObjectScope>
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_9","title":"Inherited from","text":"KubeObject.isKubeJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isnonsystem","title":"isNonSystem","text":"\u25aa Static isNonSystem: (item: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>) => boolean
\u25b8 (item): boolean
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_7","title":"Parameters","text":"Name Typeitem KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_5","title":"Returns","text":"boolean
KubeObject.isNonSystem
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"\u25aa Static isPartialJsonApiData: (object: unknown) => object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
\u25b8 (object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_8","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_6","title":"Returns","text":"object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_11","title":"Inherited from","text":"KubeObject.isPartialJsonApiData
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"\u25aa Static isPartialJsonApiMetadata: (object: unknown) => object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
\u25b8 (object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_9","title":"Parameters","text":"Name Typeobject unknown"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_7","title":"Returns","text":"object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#inherited-from_12","title":"Inherited from","text":"KubeObject.isPartialJsonApiMetadata
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#kind_1","title":"kind","text":"\u25aa Static Readonly kind: \"StorageClass\"
KubeObject.kind
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#namespaced","title":"namespaced","text":"\u25aa Static Readonly namespaced: false
KubeObject.namespaced
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#stringifylabels","title":"stringifyLabels","text":"\u25aa Static stringifyLabels: (labels?: Partial<Record<string, string>>) => string[]
\u25b8 (labels?): string[]
Deprecated
Switch to using __type instead
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_10","title":"Parameters","text":"Name Typelabels? Partial<Record<string, string>>"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_8","title":"Returns","text":"string[]
KubeObject.stringifyLabels
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#selflink","title":"selfLink","text":"\u2022 get selfLink(): string
string
KubeObject.selfLink
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#delete","title":"delete","text":"\u25b8 delete(params?): void
Deprecated
use KubeApi.delete instead
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_11","title":"Parameters","text":"Name Typeparams? object"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_10","title":"Returns","text":"void
KubeObject.delete
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getage","title":"getAge","text":"\u25b8 getAge(humanize?, compact?, fromNow?): string | number
Deprecated
This function computes a new \"now\" on every call might cause subtle issues if called multiple times
NOTE: this function also is not reactive to updates in the current time so it should not be used for rendering
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_12","title":"Parameters","text":"Name Typehumanize? boolean compact? boolean fromNow? boolean"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_11","title":"Returns","text":"string | number
KubeObject.getAge
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getannotations","title":"getAnnotations","text":"\u25b8 getAnnotations(filter?): string[]
filter? boolean"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_12","title":"Returns","text":"string[]
KubeObject.getAnnotations
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getcreationtimestamp","title":"getCreationTimestamp","text":"\u25b8 getCreationTimestamp(): number
This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_13","title":"Returns","text":"number
KubeObject.getCreationTimestamp
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getfinalizers","title":"getFinalizers","text":"\u25b8 getFinalizers(): string[]
string[]
KubeObject.getFinalizers
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getid","title":"getId","text":"\u25b8 getId(): string
string
KubeObject.getId
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getlabels","title":"getLabels","text":"\u25b8 getLabels(): string[]
string[]
KubeObject.getLabels
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getname","title":"getName","text":"\u25b8 getName(): string
string
KubeObject.getName
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getns","title":"getNs","text":"\u25b8 getNs(): undefined
undefined
KubeObject.getNs
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getownerrefs","title":"getOwnerRefs","text":"\u25b8 getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
KubeObject.getOwnerRefs
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getreclaimpolicy","title":"getReclaimPolicy","text":"\u25b8 getReclaimPolicy(): string
string
\u25b8 getResourceVersion(): string
string
KubeObject.getResourceVersion
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getscopedname","title":"getScopedName","text":"\u25b8 getScopedName(): string
string
KubeObject.getScopedName
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getsearchfields","title":"getSearchFields","text":"\u25b8 getSearchFields(): (undefined | string)[]
(undefined | string)[]
KubeObject.getSearchFields
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#gettimedifffromnow","title":"getTimeDiffFromNow","text":"\u25b8 getTimeDiffFromNow(): number
Deprecated
This function computes a new \"now\". Switch to using getCreationTimestamp instead
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_24","title":"Returns","text":"number
KubeObject.getTimeDiffFromNow
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getvolumebindingmode","title":"getVolumeBindingMode","text":"\u25b8 getVolumeBindingMode(): string
string
\u25b8 isDefault(): boolean
boolean
\u25b8 patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_14","title":"Parameters","text":"Name Typepatch Patch"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_27","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.patch
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#toplainobject","title":"toPlainObject","text":"\u25b8 toPlainObject(): Record<string, unknown>
Record<string, unknown>
KubeObject.toPlainObject
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#update","title":"update","text":"\u25b8 update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Deprecated
use KubeApi.patch instead
"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_15","title":"Parameters","text":"Name Typedata Partial<StorageClass>"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#returns_29","title":"Returns","text":"Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
KubeObject.update
"},{"location":"extensions/api/classes/Main.LensExtension/","title":"Main.LensExtension","text":"@k8slens/extensions / Exports / Main / LensExtension
"},{"location":"extensions/api/classes/Main.LensExtension/#class-lensextension","title":"Class: LensExtension","text":"Main.LensExtension
"},{"location":"extensions/api/classes/Main.LensExtension/#hierarchy","title":"Hierarchy","text":"LensExtension\u21b3 LensExtension
\u2022 new LensExtension(extension)
extension InstalledExtension"},{"location":"extensions/api/classes/Main.LensExtension/#overrides","title":"Overrides","text":"LensExtension.constructor
"},{"location":"extensions/api/classes/Main.LensExtension/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Main.LensExtension/#appmenus","title":"appMenus","text":"\u2022 appMenus: MenuRegistration[] | IComputedValue<MenuRegistration[]>
\u2022 Readonly id: string
LensExtension.id
"},{"location":"extensions/api/classes/Main.LensExtension/#isbundled","title":"isBundled","text":"\u2022 Readonly isBundled: boolean
LensExtension.isBundled
"},{"location":"extensions/api/classes/Main.LensExtension/#manifest","title":"manifest","text":"\u2022 Readonly manifest: LensExtensionManifest
LensExtension.manifest
"},{"location":"extensions/api/classes/Main.LensExtension/#manifestpath","title":"manifestPath","text":"\u2022 Readonly manifestPath: string
LensExtension.manifestPath
"},{"location":"extensions/api/classes/Main.LensExtension/#protocolhandlers","title":"protocolHandlers","text":"\u2022 protocolHandlers: ProtocolHandlerRegistration[]
LensExtension.protocolHandlers
"},{"location":"extensions/api/classes/Main.LensExtension/#terminalshellenvmodifier","title":"terminalShellEnvModifier","text":"\u2022 Optional terminalShellEnvModifier: ShellEnvModifier
implement this to modify the shell environment that Lens terminals are opened with. The ShellEnvModifier type has the signature
(ctx: ShellEnvContext, env: Record) => Record
Param
the shell environment context, specifically the relevant catalog entity for the terminal. This can be used, for example, to get cluster-specific information that can be made available in the shell environment by the implementation of terminalShellEnvModifier
Param
the current shell environment that the terminal will be opened with. The implementation should modify this as desired.
"},{"location":"extensions/api/classes/Main.LensExtension/#traymenus","title":"trayMenus","text":"\u2022 trayMenus: TrayMenuRegistration[] | IComputedValue<TrayMenuRegistration[]>
\u2022 get description(): undefined | string
undefined | string
LensExtension.description
"},{"location":"extensions/api/classes/Main.LensExtension/#isenabled","title":"isEnabled","text":"\u2022 get isEnabled(): boolean
boolean
LensExtension.isEnabled
"},{"location":"extensions/api/classes/Main.LensExtension/#name","title":"name","text":"\u2022 get name(): string
string
LensExtension.name
"},{"location":"extensions/api/classes/Main.LensExtension/#sanitizedextensionid","title":"sanitizedExtensionId","text":"\u2022 get sanitizedExtensionId(): string
string
LensExtension.sanitizedExtensionId
"},{"location":"extensions/api/classes/Main.LensExtension/#storename","title":"storeName","text":"\u2022 get storeName(): string
string
LensExtension.storeName
"},{"location":"extensions/api/classes/Main.LensExtension/#version","title":"version","text":"\u2022 get version(): string
string
LensExtension.version
"},{"location":"extensions/api/classes/Main.LensExtension/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Main.LensExtension/#activate","title":"activate","text":"\u25b8 activate(): Promise<void>
Promise<void>
LensExtension.activate
"},{"location":"extensions/api/classes/Main.LensExtension/#addcatalogsource","title":"addCatalogSource","text":"\u25b8 addCatalogSource(id, source): void
id string source IObservableArray<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>> | IComputedValue<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>[]>"},{"location":"extensions/api/classes/Main.LensExtension/#returns_7","title":"Returns","text":"void
\u25b8 disable(): Promise<void>
Promise<void>
LensExtension.disable
"},{"location":"extensions/api/classes/Main.LensExtension/#enable","title":"enable","text":"\u25b8 enable(): Promise<void>
Promise<void>
LensExtension.enable
"},{"location":"extensions/api/classes/Main.LensExtension/#getextensionfilefolder","title":"getExtensionFileFolder","text":"\u25b8 getExtensionFileFolder(): Promise<string>
getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension.
Note: there is no security done on this folder, only obfuscation of the folder name.
"},{"location":"extensions/api/classes/Main.LensExtension/#returns_10","title":"Returns","text":"Promise<string>
LensExtension.getExtensionFileFolder
"},{"location":"extensions/api/classes/Main.LensExtension/#navigate","title":"navigate","text":"\u25b8 navigate(pageId?, params?, frameId?): Promise<void>
pageId? string params? Record<string, any> frameId? number"},{"location":"extensions/api/classes/Main.LensExtension/#returns_11","title":"Returns","text":"Promise<void>
\u25b8 Protected onActivate(): void | Promise<void>
void | Promise<void>
LensExtension.onActivate
"},{"location":"extensions/api/classes/Main.LensExtension/#ondeactivate","title":"onDeactivate","text":"\u25b8 Protected onDeactivate(): void | Promise<void>
void | Promise<void>
LensExtension.onDeactivate
"},{"location":"extensions/api/classes/Main.LensExtension/#removecatalogsource","title":"removeCatalogSource","text":"\u25b8 removeCatalogSource(id): void
id string"},{"location":"extensions/api/classes/Main.LensExtension/#returns_14","title":"Returns","text":"void
@k8slens/extensions / Exports / Renderer / Catalog / CatalogEntityRegistry
"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#class-catalogentityregistry","title":"Class: CatalogEntityRegistry","text":"Renderer.Catalog.CatalogEntityRegistry
"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructors","title":"Constructors","text":"\u2022 new CatalogEntityRegistry()
"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#activeentity","title":"activeEntity","text":"\u2022 get activeEntity(): undefined | CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>
Currently active/visible entity
"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns","title":"Returns","text":"undefined | CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>
\u2022 get entities(): Map<string, CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>
Map<string, CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>
\u25b8 addOnBeforeRun(onBeforeRun): Disposer
Add a onBeforeRun hook to a catalog entities. If onBeforeRun was previously added then it will not be added again.
onBeforeRun CatalogEntityOnBeforeRun The function to be called with a CatalogRunEvent event target will be the catalog entity. onBeforeRun hook can call event.preventDefault() to stop run sequence"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns_2","title":"Returns","text":"Disposer
A function to remove that hook
"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>
id string"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns_3","title":"Returns","text":"undefined | CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>
\u25b8 getItemsForApiKind<T>(apiVersion, kind): T[]
T extends CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec, T>"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#parameters_2","title":"Parameters","text":"Name Type apiVersion string kind string"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns_4","title":"Returns","text":"T[]
\u25b8 getItemsForCategory<T>(category): T[]
T extends CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec, T>"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#parameters_3","title":"Parameters","text":"Name Type category CatalogCategory"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#returns_5","title":"Returns","text":"T[]
@k8slens/extensions / Exports / Renderer / Component / DrawerParamToggler
"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#class-drawerparamtoggler","title":"Class: DrawerParamToggler","text":"Renderer.Component.DrawerParamToggler
"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#hierarchy","title":"Hierarchy","text":"Component<DrawerParamTogglerProps, State>\u21b3 DrawerParamToggler
\u2022 new DrawerParamToggler(props)
props DrawerParamTogglerProps | Readonly<DrawerParamTogglerProps>"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#inherited-from","title":"Inherited from","text":"React.Component<DrawerParamTogglerProps, State>.constructor
\u2022 new DrawerParamToggler(props, context)
Deprecated
See
https://legacy.reactjs.org/docs/legacy-context.html
"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#parameters_1","title":"Parameters","text":"Name Typeprops DrawerParamTogglerProps context any"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#inherited-from_1","title":"Inherited from","text":"React.Component<DrawerParamTogglerProps, State>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#state","title":"state","text":"\u2022 state: State
React.Component.state
"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#toggle","title":"toggle","text":"\u2022 toggle: () => void
\u25b8 (): void
void
\u25b8 render(): Element
Element
React.Component.render
"},{"location":"extensions/api/classes/Renderer.Component.Input/","title":"Renderer.Component.Input","text":"@k8slens/extensions / Exports / Renderer / Component / Input
"},{"location":"extensions/api/classes/Renderer.Component.Input/#class-input","title":"Class: Input","text":"Renderer.Component.Input
"},{"location":"extensions/api/classes/Renderer.Component.Input/#hierarchy","title":"Hierarchy","text":"Component<InputProps, State>\u21b3 Input
\u2022 new Input(props)
props InputProps"},{"location":"extensions/api/classes/Renderer.Component.Input/#overrides","title":"Overrides","text":"React.Component<InputProps, State\\>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.Input/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Input/#input","title":"input","text":"\u2022 input: null | InputElement
\u2022 setDirtyOnChange: DebouncedFunc<() => void>
\u2022 state: State
React.Component.state
"},{"location":"extensions/api/classes/Renderer.Component.Input/#validators","title":"validators","text":"\u2022 validators: InputValidator<boolean>[]
\u25aa Static defaultProps: object
\u2022 get isUncontrolled(): boolean
boolean
\u2022 get showMaxLenIndicator(): undefined | boolean | 0
undefined | boolean | 0
\u2022 get themeSelection(): Record<string, boolean>
Record<string, boolean>
\u25b8 bindRef(elem): void
elem InputElement"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_3","title":"Returns","text":"void
\u25b8 blur(): void
void
\u25b8 componentDidMount(): void
void
React.Component.componentDidMount
"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentdidupdate","title":"componentDidUpdate","text":"\u25b8 componentDidUpdate(prevProps): void
prevProps InputProps"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_6","title":"Returns","text":"void
React.Component.componentDidUpdate
"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentwillunmount","title":"componentWillUnmount","text":"\u25b8 componentWillUnmount(): void
void
React.Component.componentWillUnmount
"},{"location":"extensions/api/classes/Renderer.Component.Input/#focus","title":"focus","text":"\u25b8 focus(): void
void
\u25b8 getValue(): string
string
\u25b8 onBlur(evt): void
evt FocusEvent<InputElement, Element>"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_10","title":"Returns","text":"void
\u25b8 onChange(evt): Promise<void>
evt ChangeEvent<any>"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_11","title":"Returns","text":"Promise<void>
\u25b8 onFocus(evt): void
evt FocusEvent<InputElement, Element>"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_12","title":"Returns","text":"void
\u25b8 onKeyDown(evt): void
evt KeyboardEvent<InputElement>"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_13","title":"Returns","text":"void
\u25b8 render(): Element
Element
React.Component.render
"},{"location":"extensions/api/classes/Renderer.Component.Input/#select","title":"select","text":"\u25b8 select(): void
void
\u25b8 setDirty(dirty?): void
dirty? boolean"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_16","title":"Returns","text":"void
\u25b8 setValidation(errors): void
errors StrictReactNode[]"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_17","title":"Returns","text":"void
\u25b8 setValue(value?): void
value? string"},{"location":"extensions/api/classes/Renderer.Component.Input/#returns_18","title":"Returns","text":"void
\u25b8 validate(): Promise<void>
Promise<void>
@k8slens/extensions / Exports / Renderer / Component / MenuItem
"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#class-menuitem","title":"Class: MenuItem","text":"Renderer.Component.MenuItem
"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#hierarchy","title":"Hierarchy","text":"Component<MenuItemProps>\u21b3 MenuItem
\u2022 new MenuItem(props)
props MenuItemProps"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#overrides","title":"Overrides","text":"React.Component<MenuItemProps\\>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#context","title":"context","text":"\u2022 context: MenuContextValue
React.Component.context
"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#elem","title":"elem","text":"\u2022 elem: null | HTMLElement
\u25aa Static contextType: Context<null | MenuContextValue>
React.Component.contextType
"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#defaultprops","title":"defaultProps","text":"\u25aa Static defaultProps: object
\u2022 get isFocusable(): boolean
boolean
\u2022 get isLink(): boolean
boolean
\u25b8 Protected bindRef(elem): void
elem HTMLElement"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#returns_2","title":"Returns","text":"void
\u25b8 onClick(evt): void
evt MouseEvent<Element, MouseEvent>"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#returns_3","title":"Returns","text":"void
\u25b8 render(): Element
Element
React.Component.render
"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/","title":"Renderer.Component.NotificationsStore","text":"@k8slens/extensions / Exports / Renderer / Component / NotificationsStore
"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#class-notificationsstore","title":"Class: NotificationsStore","text":"Renderer.Component.NotificationsStore
"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructors","title":"Constructors","text":"\u2022 new NotificationsStore()
"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#autohidetimers","title":"autoHideTimers","text":"\u2022 Protected autoHideTimers: Map<NotificationId, number>
\u2022 notifications: IObservableArray<{ id: NotificationId ; message: NotificationMessage ; onClose?: () => void ; status?: NotificationStatus ; timeout?: number }>
\u25b8 add(rawNotification): () => void
rawNotification Notification"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns","title":"Returns","text":"fn
\u25b8 (): void
void
\u25b8 addAutoHideTimer(id): void
id NotificationId"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns_2","title":"Returns","text":"void
\u25b8 getById(id): undefined | { id: NotificationId ; message: NotificationMessage ; onClose?: () => void ; status?: NotificationStatus ; timeout?: number }
id NotificationId"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns_3","title":"Returns","text":"undefined | { id: NotificationId ; message: NotificationMessage ; onClose?: () => void ; status?: NotificationStatus ; timeout?: number }
\u25b8 remove(id): void
id NotificationId"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns_4","title":"Returns","text":"void
\u25b8 removeAutoHideTimer(id): void
id NotificationId"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#returns_5","title":"Returns","text":"void
@k8slens/extensions / Exports / Renderer / Component / PageLayout
"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#class-pagelayout","title":"Class: PageLayout","text":"Renderer.Component.PageLayout
PageLayout is deprecated. See MainLayout & SettingLayout
Deprecated
SettingLayout\u21b3 PageLayout
\u2022 new PageLayout(props)
props SettingLayoutProps | Readonly<SettingLayoutProps>"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from","title":"Inherited from","text":"SettingLayout.constructor
\u2022 new PageLayout(props, context)
Deprecated
See
https://legacy.reactjs.org/docs/legacy-context.html
"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#parameters_1","title":"Parameters","text":"Name Typeprops SettingLayoutProps context any"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#inherited-from_1","title":"Inherited from","text":"SettingLayout.constructor
"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#onescapekey","title":"onEscapeKey","text":"\u2022 onEscapeKey: (evt: KeyboardEvent) => void
\u25b8 (evt): void
evt KeyboardEvent"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#returns","title":"Returns","text":"void
SettingLayout.onEscapeKey
"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#defaultprops","title":"defaultProps","text":"\u25aa Static defaultProps: object
SettingLayout.defaultProps
"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentdidmount","title":"componentDidMount","text":"\u25b8 componentDidMount(): Promise<void>
Promise<void>
SettingLayout.componentDidMount
"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentwillunmount","title":"componentWillUnmount","text":"\u25b8 componentWillUnmount(): void
void
SettingLayout.componentWillUnmount
"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#render","title":"render","text":"\u25b8 render(): Element
Element
SettingLayout.render
"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/","title":"Renderer.Component.SettingLayout","text":"@k8slens/extensions / Exports / Renderer / Component / SettingLayout
"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#class-settinglayout","title":"Class: SettingLayout","text":"Renderer.Component.SettingLayout
Layout for settings like pages with navigation
"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#hierarchy","title":"Hierarchy","text":"Component<SettingLayoutProps>\u21b3 SettingLayout
\u21b3\u21b3 PageLayout
\u2022 new SettingLayout(props)
props SettingLayoutProps | Readonly<SettingLayoutProps>"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#inherited-from","title":"Inherited from","text":"React.Component<SettingLayoutProps>.constructor
\u2022 new SettingLayout(props, context)
Deprecated
See
https://legacy.reactjs.org/docs/legacy-context.html
"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#parameters_1","title":"Parameters","text":"Name Typeprops SettingLayoutProps context any"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#inherited-from_1","title":"Inherited from","text":"React.Component<SettingLayoutProps>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#onescapekey","title":"onEscapeKey","text":"\u2022 onEscapeKey: (evt: KeyboardEvent) => void
\u25b8 (evt): void
evt KeyboardEvent"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#returns","title":"Returns","text":"void
\u25aa Static defaultProps: object
\u25b8 componentDidMount(): Promise<void>
Promise<void>
React.Component.componentDidMount
"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentwillunmount","title":"componentWillUnmount","text":"\u25b8 componentWillUnmount(): void
void
React.Component.componentWillUnmount
"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#render","title":"render","text":"\u25b8 render(): Element
Element
React.Component.render
"},{"location":"extensions/api/classes/Renderer.Component.Slider/","title":"Renderer.Component.Slider","text":"@k8slens/extensions / Exports / Renderer / Component / Slider
"},{"location":"extensions/api/classes/Renderer.Component.Slider/#class-slider","title":"Class: Slider","text":"Renderer.Component.Slider
"},{"location":"extensions/api/classes/Renderer.Component.Slider/#hierarchy","title":"Hierarchy","text":"Component<SliderProps>\u21b3 Slider
\u2022 new Slider(props)
props SliderProps | Readonly<SliderProps>"},{"location":"extensions/api/classes/Renderer.Component.Slider/#inherited-from","title":"Inherited from","text":"Component<SliderProps>.constructor
\u2022 new Slider(props, context)
Deprecated
See
https://legacy.reactjs.org/docs/legacy-context.html
"},{"location":"extensions/api/classes/Renderer.Component.Slider/#parameters_1","title":"Parameters","text":"Name Typeprops SliderProps context any"},{"location":"extensions/api/classes/Renderer.Component.Slider/#inherited-from_1","title":"Inherited from","text":"Component<SliderProps>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.Slider/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Slider/#defaultprops","title":"defaultProps","text":"\u25aa Static defaultProps: object
\u25b8 render(): Element
Element
Component.render
"},{"location":"extensions/api/classes/Renderer.Component.Spinner/","title":"Renderer.Component.Spinner","text":"@k8slens/extensions / Exports / Renderer / Component / Spinner
"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#class-spinner","title":"Class: Spinner","text":"Renderer.Component.Spinner
"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#hierarchy","title":"Hierarchy","text":"Component<SpinnerProps, {}>\u21b3 Spinner
\u2022 new Spinner(props)
props SpinnerProps | Readonly<SpinnerProps>"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#inherited-from","title":"Inherited from","text":"React.Component<SpinnerProps, {}>.constructor
\u2022 new Spinner(props, context)
Deprecated
See
https://legacy.reactjs.org/docs/legacy-context.html
"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#parameters_1","title":"Parameters","text":"Name Typeprops SpinnerProps context any"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#inherited-from_1","title":"Inherited from","text":"React.Component<SpinnerProps, {}>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Spinner/#defaultprops","title":"defaultProps","text":"\u25aa Static defaultProps: Object
center boolean singleColor boolean"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Spinner/#render","title":"render","text":"\u25b8 render(): Element
Element
React.Component.render
"},{"location":"extensions/api/classes/Renderer.Component.Stepper/","title":"Renderer.Component.Stepper","text":"@k8slens/extensions / Exports / Renderer / Component / Stepper
"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#class-stepper","title":"Class: Stepper","text":"Renderer.Component.Stepper
"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#hierarchy","title":"Hierarchy","text":"Component<StepperProps, {}>\u21b3 Stepper
\u2022 new Stepper(props)
props StepperProps | Readonly<StepperProps>"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#inherited-from","title":"Inherited from","text":"React.Component<StepperProps, {}>.constructor
\u2022 new Stepper(props, context)
Deprecated
See
https://legacy.reactjs.org/docs/legacy-context.html
"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#parameters_1","title":"Parameters","text":"Name Typeprops StepperProps context any"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#inherited-from_1","title":"Inherited from","text":"React.Component<StepperProps, {}>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.Stepper/#render","title":"render","text":"\u25b8 render(): Element
Element
React.Component.render
"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/","title":"Renderer.Component.SubTitle","text":"@k8slens/extensions / Exports / Renderer / Component / SubTitle
"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#class-subtitle","title":"Class: SubTitle","text":"Renderer.Component.SubTitle
"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#hierarchy","title":"Hierarchy","text":"Component<SubTitleProps>\u21b3 SubTitle
\u2022 new SubTitle(props)
props SubTitleProps | Readonly<SubTitleProps>"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#inherited-from","title":"Inherited from","text":"React.Component<SubTitleProps>.constructor
\u2022 new SubTitle(props, context)
Deprecated
See
https://legacy.reactjs.org/docs/legacy-context.html
"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#parameters_1","title":"Parameters","text":"Name Typeprops SubTitleProps context any"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#inherited-from_1","title":"Inherited from","text":"React.Component<SubTitleProps>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#render","title":"render","text":"\u25b8 render(): Element
Element
React.Component.render
"},{"location":"extensions/api/classes/Renderer.Component.Tab/","title":"Renderer.Component.Tab","text":"@k8slens/extensions / Exports / Renderer / Component / Tab
"},{"location":"extensions/api/classes/Renderer.Component.Tab/#class-tabd","title":"Class: Tab<D>","text":"Renderer.Component.Tab
"},{"location":"extensions/api/classes/Renderer.Component.Tab/#type-parameters","title":"Type parameters","text":"NameD"},{"location":"extensions/api/classes/Renderer.Component.Tab/#hierarchy","title":"Hierarchy","text":"PureComponent<TabProps<D>>\u21b3 Tab
\u2022 new Tab<D>(props)
D"},{"location":"extensions/api/classes/Renderer.Component.Tab/#parameters","title":"Parameters","text":"Name Type props TabProps<D>"},{"location":"extensions/api/classes/Renderer.Component.Tab/#overrides","title":"Overrides","text":"React.PureComponent<TabProps<D\\>\\>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.Tab/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Tab/#context","title":"context","text":"\u2022 context: TabsContextValue<D>
React.PureComponent.context
"},{"location":"extensions/api/classes/Renderer.Component.Tab/#ref","title":"ref","text":"\u2022 ref: RefObject<HTMLDivElement>
\u25aa Static contextType: Context<TabsContextValue<unknown>>
React.PureComponent.contextType
"},{"location":"extensions/api/classes/Renderer.Component.Tab/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.Component.Tab/#isactive","title":"isActive","text":"\u2022 get isActive(): boolean
boolean
\u25b8 componentDidMount(): void
void
React.PureComponent.componentDidMount
"},{"location":"extensions/api/classes/Renderer.Component.Tab/#focus","title":"focus","text":"\u25b8 focus(): void
void
\u25b8 onClick(evt): void
evt MouseEvent<HTMLElement, MouseEvent>"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_3","title":"Returns","text":"void
\u25b8 onFocus(evt): void
evt FocusEvent<HTMLElement, Element>"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_4","title":"Returns","text":"void
\u25b8 onKeyDown(evt): void
evt KeyboardEvent<HTMLElement>"},{"location":"extensions/api/classes/Renderer.Component.Tab/#returns_5","title":"Returns","text":"void
\u25b8 render(): Element
Element
React.PureComponent.render
"},{"location":"extensions/api/classes/Renderer.Component.Tab/#scrollintoview","title":"scrollIntoView","text":"\u25b8 scrollIntoView(): void
void
@k8slens/extensions / Exports / Renderer / Component / TableCell
"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#class-tablecell","title":"Class: TableCell","text":"Renderer.Component.TableCell
"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#hierarchy","title":"Hierarchy","text":"Component<TableCellProps>\u21b3 TableCell
\u2022 new TableCell(props)
props TableCellProps"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#overrides","title":"Overrides","text":"React.Component<TableCellProps\\>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.TableCell/#onclick","title":"onClick","text":"\u25b8 onClick(evt): void
evt MouseEvent<HTMLDivElement, MouseEvent>"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#returns","title":"Returns","text":"void
\u25b8 render(): Element
Element
React.Component.render
"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#rendercheckbox","title":"renderCheckbox","text":"\u25b8 renderCheckbox(): null | Element
null | Element
\u25b8 renderSortIcon(): null | Element
null | Element
@k8slens/extensions / Exports / Renderer / Component / TableHead
"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#class-tablehead","title":"Class: TableHead","text":"Renderer.Component.TableHead
"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#hierarchy","title":"Hierarchy","text":"Component<TableHeadProps>\u21b3 TableHead
\u2022 new TableHead(props)
props TableHeadProps | Readonly<TableHeadProps>"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#inherited-from","title":"Inherited from","text":"React.Component<TableHeadProps>.constructor
\u2022 new TableHead(props, context)
Deprecated
See
https://legacy.reactjs.org/docs/legacy-context.html
"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#parameters_1","title":"Parameters","text":"Name Typeprops TableHeadProps context any"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#inherited-from_1","title":"Inherited from","text":"React.Component<TableHeadProps>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.TableHead/#defaultprops","title":"defaultProps","text":"\u25aa Static defaultProps: TableHeadProps
\u25b8 render(): Element
Element
React.Component.render
"},{"location":"extensions/api/classes/Renderer.Component.TableRow/","title":"Renderer.Component.TableRow","text":"@k8slens/extensions / Exports / Renderer / Component / TableRow
"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#class-tablerowitem","title":"Class: TableRow<Item>","text":"Renderer.Component.TableRow
"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#type-parameters","title":"Type parameters","text":"NameItem"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#hierarchy","title":"Hierarchy","text":"Component<TableRowProps<Item>>\u21b3 TableRow
\u2022 new TableRow<Item>(props)
Item"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#parameters","title":"Parameters","text":"Name Type props TableRowProps<Item> | Readonly<TableRowProps<Item>>"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#inherited-from","title":"Inherited from","text":"React.Component<TableRowProps<Item>>.constructor
\u2022 new TableRow<Item>(props, context)
Deprecated
See
https://legacy.reactjs.org/docs/legacy-context.html
"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#type-parameters_2","title":"Type parameters","text":"NameItem"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#parameters_1","title":"Parameters","text":"Name Type props TableRowProps<Item> context any"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#inherited-from_1","title":"Inherited from","text":"React.Component<TableRowProps<Item>>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.TableRow/#render","title":"render","text":"\u25b8 render(): Element
Element
React.Component.render
"},{"location":"extensions/api/classes/Renderer.Component.Tabs/","title":"Renderer.Component.Tabs","text":"@k8slens/extensions / Exports / Renderer / Component / Tabs
"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#class-tabsd","title":"Class: Tabs<D>","text":"Renderer.Component.Tabs
"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#type-parameters","title":"Type parameters","text":"NameD"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#hierarchy","title":"Hierarchy","text":"PureComponent<TabsProps<D>>\u21b3 Tabs
\u2022 new Tabs<D>(props)
D"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#parameters","title":"Parameters","text":"Name Type props TabsProps<D> | Readonly<TabsProps<D>>"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#inherited-from","title":"Inherited from","text":"React.PureComponent<TabsProps<D>>.constructor
\u2022 new Tabs<D>(props, context)
Deprecated
See
https://legacy.reactjs.org/docs/legacy-context.html
"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#type-parameters_2","title":"Type parameters","text":"NameD"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#parameters_1","title":"Parameters","text":"Name Type props TabsProps<D> context any"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#inherited-from_1","title":"Inherited from","text":"React.PureComponent<TabsProps<D>>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Tabs/#elem","title":"elem","text":"\u2022 elem: null | HTMLDivElement
\u25b8 render(): Element
Element
React.PureComponent.render
"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/","title":"Renderer.Component.TerminalStore","text":"@k8slens/extensions / Exports / Renderer / Component / TerminalStore
"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#class-terminalstore","title":"Class: TerminalStore","text":"Renderer.Component.TerminalStore
"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructors","title":"Constructors","text":"\u2022 new TerminalStore()
"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#createinstance","title":"createInstance","text":"\u25b8 Static createInstance(): TerminalStore & { sendCommand: SendCommand }
TerminalStore & { sendCommand: SendCommand }
\u25b8 Static getInstance(): TerminalStore & { sendCommand: SendCommand }
TerminalStore & { sendCommand: SendCommand }
\u25b8 Static resetInstance(): void
void
@k8slens/extensions / Exports / Renderer / Component / Wizard
"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#class-wizardd","title":"Class: Wizard<D>","text":"Renderer.Component.Wizard
"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-parameters","title":"Type parameters","text":"NameD"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#hierarchy","title":"Hierarchy","text":"Component<WizardProps<D>, State>\u21b3 Wizard
\u2022 new Wizard<D>(props)
D"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#parameters","title":"Parameters","text":"Name Type props WizardProps<D> | Readonly<WizardProps<D>>"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#inherited-from","title":"Inherited from","text":"React.Component<WizardProps<D>, State>.constructor
\u2022 new Wizard<D>(props, context)
Deprecated
See
https://legacy.reactjs.org/docs/legacy-context.html
"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-parameters_2","title":"Type parameters","text":"NameD"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#parameters_1","title":"Parameters","text":"Name Type props WizardProps<D> context any"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#inherited-from_1","title":"Inherited from","text":"React.Component<WizardProps<D>, State>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.Wizard/#firststep","title":"firstStep","text":"\u2022 firstStep: () => any
\u25b8 (): any
any
\u2022 isFirstStep: () => boolean
\u25b8 (): boolean
boolean
\u2022 isLastStep: () => boolean
\u25b8 (): boolean
boolean
\u2022 lastStep: () => any
\u25b8 (): any
any
\u2022 nextStep: () => any
\u25b8 (): any
any
\u2022 prevStep: () => any
\u25b8 (): any
any
\u2022 state: State
React.Component.state
"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.Component.Wizard/#step","title":"step","text":"\u2022 get step(): number
number
\u2022 set step(step): void
step number"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_7","title":"Returns","text":"void
\u2022 get steps(): ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>>[]
ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>>[]
\u25b8 Protected getValidStep(step): number
step number"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#returns_9","title":"Returns","text":"number
\u25b8 render(): Element
Element
React.Component.render
"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/","title":"Renderer.Component.WizardLayout","text":"@k8slens/extensions / Exports / Renderer / Component / WizardLayout
"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#class-wizardlayout","title":"Class: WizardLayout","text":"Renderer.Component.WizardLayout
"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#hierarchy","title":"Hierarchy","text":"Component<WizardLayoutProps>\u21b3 WizardLayout
\u2022 new WizardLayout(props)
props WizardLayoutProps | Readonly<WizardLayoutProps>"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#inherited-from","title":"Inherited from","text":"React.Component<WizardLayoutProps>.constructor
\u2022 new WizardLayout(props, context)
Deprecated
See
https://legacy.reactjs.org/docs/legacy-context.html
"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#parameters_1","title":"Parameters","text":"Name Typeprops WizardLayoutProps context any"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#inherited-from_1","title":"Inherited from","text":"React.Component<WizardLayoutProps>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#render","title":"render","text":"\u25b8 render(): Element
Element
React.Component.render
"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/","title":"Renderer.Component.WizardStep","text":"@k8slens/extensions / Exports / Renderer / Component / WizardStep
"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#class-wizardstepd","title":"Class: WizardStep<D>","text":"Renderer.Component.WizardStep
"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#type-parameters","title":"Type parameters","text":"NameD"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#hierarchy","title":"Hierarchy","text":"Component<WizardStepProps<D>, WizardStepState>\u21b3 WizardStep
\u2022 new WizardStep<D>(props)
D"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#parameters","title":"Parameters","text":"Name Type props WizardStepProps<D> | Readonly<WizardStepProps<D>>"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#inherited-from","title":"Inherited from","text":"React.Component<WizardStepProps<D>, WizardStepState>.constructor
\u2022 new WizardStep<D>(props, context)
Deprecated
See
https://legacy.reactjs.org/docs/legacy-context.html
"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#type-parameters_2","title":"Type parameters","text":"NameD"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#parameters_1","title":"Parameters","text":"Name Type props WizardStepProps<D> context any"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#inherited-from_1","title":"Inherited from","text":"React.Component<WizardStepProps<D>, WizardStepState>.constructor
"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#next","title":"next","text":"\u2022 next: () => void
\u25b8 (): void
void
\u2022 prev: () => void
\u25b8 (): void
void
\u2022 state: WizardStepState
React.Component.state
"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#submit","title":"submit","text":"\u2022 submit: DebouncedFunc<() => void>
\u25aa Static defaultProps: WizardStepProps<any>
\u25b8 componentWillUnmount(): void
void
React.Component.componentWillUnmount
"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#keydown","title":"keyDown","text":"\u25b8 keyDown(evt): void
evt KeyboardEvent<HTMLElement>"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#returns_3","title":"Returns","text":"void
\u25b8 render(): null | Element
null | Element
React.Component.render
"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#renderloading","title":"renderLoading","text":"\u25b8 renderLoading(): Element
Element
@k8slens/extensions / Exports / Renderer / Ipc
"},{"location":"extensions/api/classes/Renderer.Ipc/#class-ipc","title":"Class: Ipc","text":"Renderer.Ipc
"},{"location":"extensions/api/classes/Renderer.Ipc/#hierarchy","title":"Hierarchy","text":"IpcRegistrar\u21b3 Ipc
\u2022 new Ipc(extension)
extension LensExtension"},{"location":"extensions/api/classes/Renderer.Ipc/#overrides","title":"Overrides","text":"IpcRegistrar.constructor
"},{"location":"extensions/api/classes/Renderer.Ipc/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Ipc/#ipcprefix","title":"[IpcPrefix]","text":"\u2022 Readonly [IpcPrefix]: string
IpcRegistrar.[IpcPrefix]
"},{"location":"extensions/api/classes/Renderer.Ipc/#extension","title":"extension","text":"\u2022 Protected Readonly extension: LensExtension
IpcRegistrar.extension
"},{"location":"extensions/api/classes/Renderer.Ipc/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.Ipc/#broadcast","title":"broadcast","text":"\u25b8 broadcast(channel, ...args): void
channel string The channel to broadcast to your whole extension, both main and renderer ...args any[] The arguments passed to all listeners"},{"location":"extensions/api/classes/Renderer.Ipc/#returns","title":"Returns","text":"void
IpcRegistrar.broadcast
"},{"location":"extensions/api/classes/Renderer.Ipc/#invoke","title":"invoke","text":"\u25b8 invoke(channel, ...args): Promise<any>
Request main to execute its function over the channel channel. This function only interacts with functions registered via Ipc.IpcMain.handleRpc An error will be thrown if no function has been registered on main with this channel ID.
channel string The channel to invoke a RPC on ...args any[] The arguments to pass to the RPC"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_1","title":"Returns","text":"Promise<any>
A promise of the resulting value
"},{"location":"extensions/api/classes/Renderer.Ipc/#listen","title":"listen","text":"\u25b8 listen(channel, listener): Disposer
Listen for broadcasts within your extension. If the lifetime of the listener should be tied to the mounted lifetime of a component then putting the returned value in a disposeOnUnmount call will suffice.
channel string The channel to listen for broadcasts on listener (event: IpcRendererEvent, ...args: any[]) => any The function that will be called with the arguments of the broadcast"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_2","title":"Returns","text":"Disposer
An optional disposer, Lens will cleanup even if this is not called
"},{"location":"extensions/api/classes/Renderer.Ipc/#createinstance","title":"createInstance","text":"\u25b8 Static createInstance<T, R>(this, ...args): T
Creates the single instance of the child class if one was not already created.
Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls.
Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.
"},{"location":"extensions/api/classes/Renderer.Ipc/#type-parameters","title":"Type parameters","text":"Name TypeT extends Singleton<T> R extends any[]"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters_4","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type ...args R The constructor arguments for the child class"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_3","title":"Returns","text":"T
An instance of the child class
"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from_3","title":"Inherited from","text":"IpcRegistrar.createInstance
"},{"location":"extensions/api/classes/Renderer.Ipc/#getinstance","title":"getInstance","text":"\u25b8 Static getInstance<T, R>(this, strict?): T
Get the instance of the child class that was previously created.
"},{"location":"extensions/api/classes/Renderer.Ipc/#type-parameters_1","title":"Type parameters","text":"Name TypeT T R extends any[]"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters_5","title":"Parameters","text":"Name Type Description this StaticThis<T, R> Implicit argument that is the child class type strict? true If false will return undefined instead of throwing when an instance doesn't exist. Default: true"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_4","title":"Returns","text":"T
An instance of the child class
"},{"location":"extensions/api/classes/Renderer.Ipc/#inherited-from_4","title":"Inherited from","text":"IpcRegistrar.getInstance
\u25b8 Static getInstance<T, R>(this, strict): undefined | T
T T R extends any[]"},{"location":"extensions/api/classes/Renderer.Ipc/#parameters_6","title":"Parameters","text":"Name Type this StaticThis<T, R> strict false"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_5","title":"Returns","text":"undefined | T
IpcRegistrar.getInstance
"},{"location":"extensions/api/classes/Renderer.Ipc/#resetinstance","title":"resetInstance","text":"\u25b8 Static resetInstance(): void
Delete the instance of the child class.
Note: this doesn't prevent callers of getInstance from storing the result in a global.
There is no way in JS or TS to prevent globals like that.
"},{"location":"extensions/api/classes/Renderer.Ipc/#returns_6","title":"Returns","text":"void
IpcRegistrar.resetInstance
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/","title":"Renderer.K8sApi.CRDResourceStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / CRDResourceStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#class-crdresourcestorek","title":"Class: CRDResourceStore<K>","text":"Renderer.K8sApi.CRDResourceStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#type-parameters","title":"Type parameters","text":"Name TypeK extends KubeObject"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<K, KubeApi<K>>\u21b3 CRDResourceStore
\u2022 new CRDResourceStore<K>(deps, api)
K extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, K>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#parameters","title":"Parameters","text":"Name Type deps KubeObjectStoreDependencies api KubeApi<K, KubeJsonApiDataFor<K>>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#overrides","title":"Overrides","text":"KubeObjectStore<K, KubeApi<K\\>\\>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#api","title":"api","text":"\u2022 Readonly api: KubeApi<K, KubeJsonApiDataFor<K>>
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: K) => string
\u25b8 (item): string
item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiDataFor<K> extends KubeJsonApiDataFor<K> ? KubeJsonApiDataFor<K> : never>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#items","title":"items","text":"\u2022 items: IObservableArray<K>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<K, void, undefined>
Generator<K, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<K>
params Object params.name string params.namespace? string data? PartialDeep<K, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_6","title":"Returns","text":"Promise<K>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | K>
params Object params.name string params.namespace? string data? PartialDeep<K, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_7","title":"Returns","text":"Promise<null | K>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): K[]
items K[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_8","title":"Returns","text":"K[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): K[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_9","title":"Returns","text":"K[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | K
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_10","title":"Returns","text":"undefined | K
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): K[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_11","title":"Returns","text":"K[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | K
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_12","title":"Returns","text":"undefined | K
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | K
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_13","title":"Returns","text":"undefined | K
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getitems","title":"getItems","text":"\u25b8 getItems(): K[]
K[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? K[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#load","title":"load","text":"\u25b8 load(params): Promise<K>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_19","title":"Returns","text":"Promise<K>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | K[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_20","title":"Returns","text":"Promise<undefined | K[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<K>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_21","title":"Returns","text":"Promise<K>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | K>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_22","title":"Returns","text":"Promise<null | K>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<K[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_23","title":"Returns","text":"Promise<K[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): K[]
partialItems K[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_24","title":"Returns","text":"K[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<K>
item K patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_25","title":"Returns","text":"Promise<K>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): K[]
items K[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_26","title":"Returns","text":"K[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | K[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_27","title":"Returns","text":"Promise<undefined | K[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item K request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items K[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#select","title":"select","text":"\u25b8 select(item): void
item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): K[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? K[] the items to be sorted (default: the current items in this store) sorting? (item: K) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_36","title":"Returns","text":"K[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? K[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item K"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<K>
item K data PartialDeep<K, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_41","title":"Returns","text":"Promise<K>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<K>
item K request () => Promise<K>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#returns_43","title":"Returns","text":"Promise<K>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/","title":"Renderer.K8sApi.CRDStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / CRDStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#class-crdstore","title":"Class: CRDStore","text":"Renderer.K8sApi.CRDStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<CustomResourceDefinition, CustomResourceDefinitionApi>\u21b3 CRDStore
\u2022 new CRDStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api CustomResourceDefinitionApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#overrides","title":"Overrides","text":"KubeObjectStore<CustomResourceDefinition, CustomResourceDefinitionApi\\>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#api","title":"api","text":"\u2022 Readonly api: CustomResourceDefinitionApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: CustomResourceDefinition) => string
\u25b8 (item): string
item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, CustomResourceDefinitionStatus, CustomResourceDefinitionSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#items","title":"items","text":"\u2022 items: IObservableArray<CustomResourceDefinition>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#groups","title":"groups","text":"\u2022 get groups(): Record<string, CustomResourceDefinition[]>
Record<string, CustomResourceDefinition[]>
\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<CustomResourceDefinition, void, undefined>
Generator<CustomResourceDefinition, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_6","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<CustomResourceDefinition>
params Object params.name string params.namespace? string data? PartialObjectDeep<CustomResourceDefinition, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_7","title":"Returns","text":"Promise<CustomResourceDefinition>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | CustomResourceDefinition>
params Object params.name string params.namespace? string data? PartialObjectDeep<CustomResourceDefinition, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_8","title":"Returns","text":"Promise<null | CustomResourceDefinition>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): CustomResourceDefinition[]
items CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_9","title":"Returns","text":"CustomResourceDefinition[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): CustomResourceDefinition[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_10","title":"Returns","text":"CustomResourceDefinition[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbygroup","title":"getByGroup","text":"\u25b8 getByGroup(group, pluralName): undefined | CustomResourceDefinition
group string pluralName string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_11","title":"Returns","text":"undefined | CustomResourceDefinition
\u25b8 getById(id): undefined | CustomResourceDefinition
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_12","title":"Returns","text":"undefined | CustomResourceDefinition
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): CustomResourceDefinition[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_13","title":"Returns","text":"CustomResourceDefinition[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | CustomResourceDefinition
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_14","title":"Returns","text":"undefined | CustomResourceDefinition
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyobject","title":"getByObject","text":"\u25b8 getByObject(obj): undefined | CustomResourceDefinition
obj KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_15","title":"Returns","text":"undefined | CustomResourceDefinition
\u25b8 getByPath(path): undefined | CustomResourceDefinition
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_16","title":"Returns","text":"undefined | CustomResourceDefinition
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_17","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getitems","title":"getItems","text":"\u25b8 getItems(): CustomResourceDefinition[]
CustomResourceDefinition[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_20","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_21","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#load","title":"load","text":"\u25b8 load(params): Promise<CustomResourceDefinition>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_22","title":"Returns","text":"Promise<CustomResourceDefinition>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | CustomResourceDefinition[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_23","title":"Returns","text":"Promise<undefined | CustomResourceDefinition[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<CustomResourceDefinition>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_24","title":"Returns","text":"Promise<CustomResourceDefinition>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | CustomResourceDefinition>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_25","title":"Returns","text":"Promise<null | CustomResourceDefinition>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<CustomResourceDefinition[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_26","title":"Returns","text":"Promise<CustomResourceDefinition[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): CustomResourceDefinition[]
partialItems CustomResourceDefinition[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_27","title":"Returns","text":"CustomResourceDefinition[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<CustomResourceDefinition>
item CustomResourceDefinition patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_28","title":"Returns","text":"Promise<CustomResourceDefinition>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): CustomResourceDefinition[]
items CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_29","title":"Returns","text":"CustomResourceDefinition[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | CustomResourceDefinition[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_30","title":"Returns","text":"Promise<undefined | CustomResourceDefinition[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_31","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item CustomResourceDefinition request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_32","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_33","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_36","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#select","title":"select","text":"\u25b8 select(item): void
item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items): CustomResourceDefinition[]
items CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_39","title":"Returns","text":"CustomResourceDefinition[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_40","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_41","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? CustomResourceDefinition[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_42","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_43","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<CustomResourceDefinition>
item CustomResourceDefinition data PartialObjectDeep<CustomResourceDefinition, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_44","title":"Returns","text":"Promise<CustomResourceDefinition>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<CustomResourceDefinition>
item CustomResourceDefinition request () => Promise<CustomResourceDefinition>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#returns_46","title":"Returns","text":"Promise<CustomResourceDefinition>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/","title":"Renderer.K8sApi.ConfigMapsStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / ConfigMapsStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#class-configmapsstore","title":"Class: ConfigMapsStore","text":"Renderer.K8sApi.ConfigMapsStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<ConfigMap, ConfigMapApi, ConfigMapData>\u21b3 ConfigMapsStore
\u2022 new ConfigMapsStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api ConfigMapApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<ConfigMap, ConfigMapApi, ConfigMapData>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#api","title":"api","text":"\u2022 Readonly api: ConfigMapApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: ConfigMap) => string
\u25b8 (item): string
item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<ConfigMapData>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#items","title":"items","text":"\u2022 items: IObservableArray<ConfigMap>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<ConfigMap, void, undefined>
Generator<ConfigMap, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<ConfigMap>
params Object params.name string params.namespace? string data? PartialObjectDeep<ConfigMap, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_6","title":"Returns","text":"Promise<ConfigMap>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | ConfigMap>
params Object params.name string params.namespace? string data? PartialObjectDeep<ConfigMap, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_7","title":"Returns","text":"Promise<null | ConfigMap>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): ConfigMap[]
items ConfigMap[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_8","title":"Returns","text":"ConfigMap[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): ConfigMap[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_9","title":"Returns","text":"ConfigMap[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | ConfigMap
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_10","title":"Returns","text":"undefined | ConfigMap
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): ConfigMap[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_11","title":"Returns","text":"ConfigMap[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | ConfigMap
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_12","title":"Returns","text":"undefined | ConfigMap
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | ConfigMap
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_13","title":"Returns","text":"undefined | ConfigMap
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getitems","title":"getItems","text":"\u25b8 getItems(): ConfigMap[]
ConfigMap[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? ConfigMap[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#load","title":"load","text":"\u25b8 load(params): Promise<ConfigMap>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_19","title":"Returns","text":"Promise<ConfigMap>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | ConfigMap[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_20","title":"Returns","text":"Promise<undefined | ConfigMap[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<ConfigMap>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_21","title":"Returns","text":"Promise<ConfigMap>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | ConfigMap>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_22","title":"Returns","text":"Promise<null | ConfigMap>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<ConfigMap[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_23","title":"Returns","text":"Promise<ConfigMap[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): ConfigMap[]
partialItems ConfigMap[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_24","title":"Returns","text":"ConfigMap[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<ConfigMap>
item ConfigMap patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_25","title":"Returns","text":"Promise<ConfigMap>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): ConfigMap[]
items ConfigMap[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_26","title":"Returns","text":"ConfigMap[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | ConfigMap[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_27","title":"Returns","text":"Promise<undefined | ConfigMap[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item ConfigMap request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items ConfigMap[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#select","title":"select","text":"\u25b8 select(item): void
item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): ConfigMap[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? ConfigMap[] the items to be sorted (default: the current items in this store) sorting? (item: ConfigMap) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_36","title":"Returns","text":"ConfigMap[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? ConfigMap[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<ConfigMap>
item ConfigMap data PartialObjectDeep<ConfigMap, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_41","title":"Returns","text":"Promise<ConfigMap>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<ConfigMap>
item ConfigMap request () => Promise<ConfigMap>"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#returns_43","title":"Returns","text":"Promise<ConfigMap>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/","title":"Renderer.K8sApi.CronJobStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / CronJobStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#class-cronjobstore","title":"Class: CronJobStore","text":"Renderer.K8sApi.CronJobStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<CronJob, CronJobApi>\u21b3 CronJobStore
\u2022 new CronJobStore(dependencies, api, opts?)
dependencies Dependencies api CronJobApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#overrides","title":"Overrides","text":"KubeObjectStore<CronJob, CronJobApi\\>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#api","title":"api","text":"\u2022 Readonly api: CronJobApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: CronJob) => string
\u25b8 (item): string
item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: Dependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, CronJobStatus, CronJobSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#items","title":"items","text":"\u2022 items: IObservableArray<CronJob>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<CronJob, void, undefined>
Generator<CronJob, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<CronJob>
params Object params.name string params.namespace? string data? PartialObjectDeep<CronJob, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_6","title":"Returns","text":"Promise<CronJob>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | CronJob>
params Object params.name string params.namespace? string data? PartialObjectDeep<CronJob, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_7","title":"Returns","text":"Promise<null | CronJob>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): CronJob[]
items CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_8","title":"Returns","text":"CronJob[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getactivejobsnum","title":"getActiveJobsNum","text":"\u25b8 getActiveJobsNum(cronJob): number
cronJob CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_9","title":"Returns","text":"number
\u25b8 getAllByNs(namespace, strict?): CronJob[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_10","title":"Returns","text":"CronJob[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | CronJob
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_11","title":"Returns","text":"undefined | CronJob
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): CronJob[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_12","title":"Returns","text":"CronJob[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | CronJob
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_13","title":"Returns","text":"undefined | CronJob
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | CronJob
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_14","title":"Returns","text":"undefined | CronJob
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_15","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getitems","title":"getItems","text":"\u25b8 getItems(): CronJob[]
CronJob[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getstatuses","title":"getStatuses","text":"\u25b8 getStatuses(cronJobs?): Object
cronJobs? CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_17","title":"Returns","text":"Object
scheduled number suspended number"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_19","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_20","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#load","title":"load","text":"\u25b8 load(params): Promise<CronJob>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_21","title":"Returns","text":"Promise<CronJob>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | CronJob[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_22","title":"Returns","text":"Promise<undefined | CronJob[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<CronJob>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_23","title":"Returns","text":"Promise<CronJob>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | CronJob>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_24","title":"Returns","text":"Promise<null | CronJob>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<CronJob[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_25","title":"Returns","text":"Promise<CronJob[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): CronJob[]
partialItems CronJob[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_26","title":"Returns","text":"CronJob[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<CronJob>
item CronJob patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_27","title":"Returns","text":"Promise<CronJob>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): CronJob[]
items CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_28","title":"Returns","text":"CronJob[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | CronJob[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_29","title":"Returns","text":"Promise<undefined | CronJob[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item CronJob request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_31","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_32","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#select","title":"select","text":"\u25b8 select(item): void
item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_37","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): CronJob[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? CronJob[] the items to be sorted (default: the current items in this store) sorting? (item: CronJob) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_38","title":"Returns","text":"CronJob[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_39","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? CronJob[]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_41","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_42","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<CronJob>
item CronJob data PartialObjectDeep<CronJob, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_43","title":"Returns","text":"Promise<CronJob>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<CronJob>
item CronJob request () => Promise<CronJob>"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#returns_45","title":"Returns","text":"Promise<CronJob>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/","title":"Renderer.K8sApi.DaemonSetStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / DaemonSetStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#class-daemonsetstore","title":"Class: DaemonSetStore","text":"Renderer.K8sApi.DaemonSetStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<DaemonSet, DaemonSetApi>\u21b3 DaemonSetStore
\u2022 new DaemonSetStore(dependencies, api, opts?)
dependencies DaemonSetStoreDependencies api DaemonSetApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#overrides","title":"Overrides","text":"KubeObjectStore<DaemonSet, DaemonSetApi\\>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#api","title":"api","text":"\u2022 Readonly api: DaemonSetApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: DaemonSet) => string
\u25b8 (item): string
item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: DaemonSetStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, DaemonSetStatus, DaemonSetSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#items","title":"items","text":"\u2022 items: IObservableArray<DaemonSet>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<DaemonSet, void, undefined>
Generator<DaemonSet, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<DaemonSet>
params Object params.name string params.namespace? string data? PartialObjectDeep<DaemonSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_6","title":"Returns","text":"Promise<DaemonSet>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | DaemonSet>
params Object params.name string params.namespace? string data? PartialObjectDeep<DaemonSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_7","title":"Returns","text":"Promise<null | DaemonSet>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): DaemonSet[]
items DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_8","title":"Returns","text":"DaemonSet[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): DaemonSet[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_9","title":"Returns","text":"DaemonSet[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | DaemonSet
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_10","title":"Returns","text":"undefined | DaemonSet
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): DaemonSet[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_11","title":"Returns","text":"DaemonSet[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | DaemonSet
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_12","title":"Returns","text":"undefined | DaemonSet
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | DaemonSet
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_13","title":"Returns","text":"undefined | DaemonSet
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getchildpods","title":"getChildPods","text":"\u25b8 getChildPods(daemonSet): Pod[]
Deprecated
Switch to using getPodsByOwnerId directly
daemonSet DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_14","title":"Returns","text":"Pod[]
\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_15","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getitems","title":"getItems","text":"\u25b8 getItems(): DaemonSet[]
DaemonSet[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getstatuses","title":"getStatuses","text":"\u25b8 getStatuses(daemonSets?): Object
daemonSets? DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_17","title":"Returns","text":"Object
failed number pending number running number"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_19","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_20","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#load","title":"load","text":"\u25b8 load(params): Promise<DaemonSet>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_21","title":"Returns","text":"Promise<DaemonSet>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | DaemonSet[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_22","title":"Returns","text":"Promise<undefined | DaemonSet[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<DaemonSet>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_23","title":"Returns","text":"Promise<DaemonSet>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | DaemonSet>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_24","title":"Returns","text":"Promise<null | DaemonSet>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<DaemonSet[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_25","title":"Returns","text":"Promise<DaemonSet[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): DaemonSet[]
partialItems DaemonSet[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_26","title":"Returns","text":"DaemonSet[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<DaemonSet>
item DaemonSet patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_27","title":"Returns","text":"Promise<DaemonSet>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): DaemonSet[]
items DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_28","title":"Returns","text":"DaemonSet[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | DaemonSet[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_29","title":"Returns","text":"Promise<undefined | DaemonSet[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item DaemonSet request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_31","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_32","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#select","title":"select","text":"\u25b8 select(item): void
item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_37","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): DaemonSet[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? DaemonSet[] the items to be sorted (default: the current items in this store) sorting? (item: DaemonSet) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_38","title":"Returns","text":"DaemonSet[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_39","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? DaemonSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_41","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_42","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<DaemonSet>
item DaemonSet data PartialObjectDeep<DaemonSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_43","title":"Returns","text":"Promise<DaemonSet>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<DaemonSet>
item DaemonSet request () => Promise<DaemonSet>"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#returns_45","title":"Returns","text":"Promise<DaemonSet>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/","title":"Renderer.K8sApi.DeploymentStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / DeploymentStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#class-deploymentstore","title":"Class: DeploymentStore","text":"Renderer.K8sApi.DeploymentStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<Deployment, DeploymentApi>\u21b3 DeploymentStore
\u2022 new DeploymentStore(dependencies, api, opts?)
dependencies DeploymentStoreDependencies api DeploymentApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#overrides","title":"Overrides","text":"KubeObjectStore<Deployment, DeploymentApi\\>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#api","title":"api","text":"\u2022 Readonly api: DeploymentApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: Deployment) => string
\u25b8 (item): string
item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: DeploymentStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, DeploymentStatus, DeploymentSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#items","title":"items","text":"\u2022 items: IObservableArray<Deployment>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<Deployment, void, undefined>
Generator<Deployment, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<Deployment>
params Object params.name string params.namespace? string data? PartialObjectDeep<Deployment, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_6","title":"Returns","text":"Promise<Deployment>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | Deployment>
params Object params.name string params.namespace? string data? PartialObjectDeep<Deployment, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_7","title":"Returns","text":"Promise<null | Deployment>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): Deployment[]
items Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_8","title":"Returns","text":"Deployment[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): Deployment[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_9","title":"Returns","text":"Deployment[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | Deployment
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_10","title":"Returns","text":"undefined | Deployment
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): Deployment[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_11","title":"Returns","text":"Deployment[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | Deployment
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_12","title":"Returns","text":"undefined | Deployment
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | Deployment
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_13","title":"Returns","text":"undefined | Deployment
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getchildpods","title":"getChildPods","text":"\u25b8 getChildPods(deployment): Pod[]
deployment Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_14","title":"Returns","text":"Pod[]
\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_15","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getitems","title":"getItems","text":"\u25b8 getItems(): Deployment[]
Deployment[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getstatuses","title":"getStatuses","text":"\u25b8 getStatuses(deployments): DeploymentStatuses
deployments Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_17","title":"Returns","text":"DeploymentStatuses
\u25b8 getStatuses(deployments): DeploymentStatuses
Deprecated
deployments undefined | Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_18","title":"Returns","text":"DeploymentStatuses
\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_20","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_21","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#load","title":"load","text":"\u25b8 load(params): Promise<Deployment>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_22","title":"Returns","text":"Promise<Deployment>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Deployment[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_23","title":"Returns","text":"Promise<undefined | Deployment[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<Deployment>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_24","title":"Returns","text":"Promise<Deployment>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | Deployment>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_25","title":"Returns","text":"Promise<null | Deployment>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Deployment[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_26","title":"Returns","text":"Promise<Deployment[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Deployment[]
partialItems Deployment[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_27","title":"Returns","text":"Deployment[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<Deployment>
item Deployment patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_28","title":"Returns","text":"Promise<Deployment>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): Deployment[]
items Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_29","title":"Returns","text":"Deployment[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | Deployment[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_30","title":"Returns","text":"Promise<undefined | Deployment[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_31","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item Deployment request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_32","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_33","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_36","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#select","title":"select","text":"\u25b8 select(item): void
item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items): Deployment[]
items Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_39","title":"Returns","text":"Deployment[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_40","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_41","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? Deployment[]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_42","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_43","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<Deployment>
item Deployment data PartialObjectDeep<Deployment, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_44","title":"Returns","text":"Promise<Deployment>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<Deployment>
item Deployment request () => Promise<Deployment>"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#returns_46","title":"Returns","text":"Promise<Deployment>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/","title":"Renderer.K8sApi.EndpointStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / EndpointStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#class-endpointstore","title":"Class: EndpointStore","text":"Renderer.K8sApi.EndpointStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<Endpoint, EndpointsApi, EndpointsData>\u21b3 EndpointStore
\u2022 new EndpointStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api EndpointsApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<Endpoints, EndpointsApi, EndpointsData>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#api","title":"api","text":"\u2022 Readonly api: EndpointsApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: Endpoint) => string
\u25b8 (item): string
item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<EndpointsData>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#items","title":"items","text":"\u2022 items: IObservableArray<Endpoint>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<Endpoint, void, undefined>
Generator<Endpoint, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<Endpoint>
params Object params.name string params.namespace? string data? PartialObjectDeep<Endpoint, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_6","title":"Returns","text":"Promise<Endpoint>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | Endpoint>
params Object params.name string params.namespace? string data? PartialObjectDeep<Endpoint, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_7","title":"Returns","text":"Promise<null | Endpoint>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): Endpoint[]
items Endpoint[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_8","title":"Returns","text":"Endpoint[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): Endpoint[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_9","title":"Returns","text":"Endpoint[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | Endpoint
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_10","title":"Returns","text":"undefined | Endpoint
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): Endpoint[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_11","title":"Returns","text":"Endpoint[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | Endpoint
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_12","title":"Returns","text":"undefined | Endpoint
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | Endpoint
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_13","title":"Returns","text":"undefined | Endpoint
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getitems","title":"getItems","text":"\u25b8 getItems(): Endpoint[]
Endpoint[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? Endpoint[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#load","title":"load","text":"\u25b8 load(params): Promise<Endpoint>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_19","title":"Returns","text":"Promise<Endpoint>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Endpoint[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_20","title":"Returns","text":"Promise<undefined | Endpoint[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<Endpoint>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_21","title":"Returns","text":"Promise<Endpoint>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | Endpoint>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_22","title":"Returns","text":"Promise<null | Endpoint>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Endpoint[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_23","title":"Returns","text":"Promise<Endpoint[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Endpoint[]
partialItems Endpoint[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_24","title":"Returns","text":"Endpoint[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<Endpoint>
item Endpoint patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_25","title":"Returns","text":"Promise<Endpoint>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): Endpoint[]
items Endpoint[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_26","title":"Returns","text":"Endpoint[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | Endpoint[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_27","title":"Returns","text":"Promise<undefined | Endpoint[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item Endpoint request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items Endpoint[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#select","title":"select","text":"\u25b8 select(item): void
item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): Endpoint[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? Endpoint[] the items to be sorted (default: the current items in this store) sorting? (item: Endpoint) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_36","title":"Returns","text":"Endpoint[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? Endpoint[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<Endpoint>
item Endpoint data PartialObjectDeep<Endpoint, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_41","title":"Returns","text":"Promise<Endpoint>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<Endpoint>
item Endpoint request () => Promise<Endpoint>"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#returns_43","title":"Returns","text":"Promise<Endpoint>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/","title":"Renderer.K8sApi.EventStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / EventStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#class-eventstore","title":"Class: EventStore","text":"Renderer.K8sApi.EventStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<KubeEvent, KubeEventApi>\u21b3 EventStore
\u2022 new EventStore(dependencies, api, opts?)
dependencies EventStoreDependencies api KubeEventApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#overrides","title":"Overrides","text":"KubeObjectStore<KubeEvent, KubeEventApi\\>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#api","title":"api","text":"\u2022 Readonly api: KubeEventApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: KubeEvent) => string
\u25b8 (item): string
item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: EventStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeEventData>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#items","title":"items","text":"\u2022 items: IObservableArray<KubeEvent>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#limit","title":"limit","text":"\u2022 Readonly limit: number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<KubeEvent, void, undefined>
Generator<KubeEvent, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(): void
void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<KubeEvent>
params Object params.name string params.namespace? string data? PartialObjectDeep<KubeEvent, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_6","title":"Returns","text":"Promise<KubeEvent>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | KubeEvent>
params Object params.name string params.namespace? string data? PartialObjectDeep<KubeEvent, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_7","title":"Returns","text":"Promise<null | KubeEvent>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): KubeEvent[]
items KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_8","title":"Returns","text":"KubeEvent[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): KubeEvent[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_9","title":"Returns","text":"KubeEvent[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | KubeEvent
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_10","title":"Returns","text":"undefined | KubeEvent
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): KubeEvent[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_11","title":"Returns","text":"KubeEvent[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | KubeEvent
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_12","title":"Returns","text":"undefined | KubeEvent
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | KubeEvent
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_13","title":"Returns","text":"undefined | KubeEvent
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#geteventsbyobject","title":"getEventsByObject","text":"\u25b8 getEventsByObject(obj): KubeEvent[]
obj KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_14","title":"Returns","text":"KubeEvent[]
\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_15","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getitems","title":"getItems","text":"\u25b8 getItems(): KubeEvent[]
KubeEvent[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getwarnings","title":"getWarnings","text":"\u25b8 getWarnings(): KubeEvent[]
KubeEvent[]
\u25b8 getWarningsCount(): number
number
\u25b8 isSelected(item): boolean
item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_20","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_21","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#load","title":"load","text":"\u25b8 load(params): Promise<KubeEvent>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_22","title":"Returns","text":"Promise<KubeEvent>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | KubeEvent[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_23","title":"Returns","text":"Promise<undefined | KubeEvent[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<KubeEvent>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_24","title":"Returns","text":"Promise<KubeEvent>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | KubeEvent>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_25","title":"Returns","text":"Promise<null | KubeEvent>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<KubeEvent[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_26","title":"Returns","text":"Promise<KubeEvent[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): KubeEvent[]
partialItems KubeEvent[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_27","title":"Returns","text":"KubeEvent[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<KubeEvent>
item KubeEvent patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_28","title":"Returns","text":"Promise<KubeEvent>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): KubeEvent[]
items KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_29","title":"Returns","text":"KubeEvent[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | KubeEvent[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_30","title":"Returns","text":"Promise<undefined | KubeEvent[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_31","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item KubeEvent request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_32","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_33","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_36","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#select","title":"select","text":"\u25b8 select(item): void
item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items): KubeEvent[]
items KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_39","title":"Returns","text":"KubeEvent[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_40","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_41","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? KubeEvent[]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_42","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_43","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<KubeEvent>
item KubeEvent data PartialObjectDeep<KubeEvent, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_44","title":"Returns","text":"Promise<KubeEvent>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<KubeEvent>
item KubeEvent request () => Promise<KubeEvent>"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#returns_46","title":"Returns","text":"Promise<KubeEvent>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/","title":"Renderer.K8sApi.HPAStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / HPAStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#class-hpastore","title":"Class: HPAStore","text":"Renderer.K8sApi.HPAStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<HorizontalPodAutoscaler, HorizontalPodAutoscalerApi>\u21b3 HPAStore
\u2022 new HPAStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api HorizontalPodAutoscalerApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<HorizontalPodAutoscaler, HorizontalPodAutoscalerApi>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#api","title":"api","text":"\u2022 Readonly api: HorizontalPodAutoscalerApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: HorizontalPodAutoscaler) => string
\u25b8 (item): string
item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, HorizontalPodAutoscalerStatus, HorizontalPodAutoscalerSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#items","title":"items","text":"\u2022 items: IObservableArray<HorizontalPodAutoscaler>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<HorizontalPodAutoscaler, void, undefined>
Generator<HorizontalPodAutoscaler, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<HorizontalPodAutoscaler>
params Object params.name string params.namespace? string data? PartialObjectDeep<HorizontalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_6","title":"Returns","text":"Promise<HorizontalPodAutoscaler>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | HorizontalPodAutoscaler>
params Object params.name string params.namespace? string data? PartialObjectDeep<HorizontalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_7","title":"Returns","text":"Promise<null | HorizontalPodAutoscaler>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): HorizontalPodAutoscaler[]
items HorizontalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_8","title":"Returns","text":"HorizontalPodAutoscaler[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): HorizontalPodAutoscaler[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_9","title":"Returns","text":"HorizontalPodAutoscaler[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | HorizontalPodAutoscaler
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_10","title":"Returns","text":"undefined | HorizontalPodAutoscaler
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): HorizontalPodAutoscaler[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_11","title":"Returns","text":"HorizontalPodAutoscaler[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | HorizontalPodAutoscaler
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_12","title":"Returns","text":"undefined | HorizontalPodAutoscaler
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | HorizontalPodAutoscaler
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_13","title":"Returns","text":"undefined | HorizontalPodAutoscaler
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getitems","title":"getItems","text":"\u25b8 getItems(): HorizontalPodAutoscaler[]
HorizontalPodAutoscaler[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? HorizontalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#load","title":"load","text":"\u25b8 load(params): Promise<HorizontalPodAutoscaler>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_19","title":"Returns","text":"Promise<HorizontalPodAutoscaler>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | HorizontalPodAutoscaler[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_20","title":"Returns","text":"Promise<undefined | HorizontalPodAutoscaler[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<HorizontalPodAutoscaler>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_21","title":"Returns","text":"Promise<HorizontalPodAutoscaler>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | HorizontalPodAutoscaler>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_22","title":"Returns","text":"Promise<null | HorizontalPodAutoscaler>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<HorizontalPodAutoscaler[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_23","title":"Returns","text":"Promise<HorizontalPodAutoscaler[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): HorizontalPodAutoscaler[]
partialItems HorizontalPodAutoscaler[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_24","title":"Returns","text":"HorizontalPodAutoscaler[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<HorizontalPodAutoscaler>
item HorizontalPodAutoscaler patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_25","title":"Returns","text":"Promise<HorizontalPodAutoscaler>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): HorizontalPodAutoscaler[]
items HorizontalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_26","title":"Returns","text":"HorizontalPodAutoscaler[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | HorizontalPodAutoscaler[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_27","title":"Returns","text":"Promise<undefined | HorizontalPodAutoscaler[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item HorizontalPodAutoscaler request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items HorizontalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#select","title":"select","text":"\u25b8 select(item): void
item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): HorizontalPodAutoscaler[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? HorizontalPodAutoscaler[] the items to be sorted (default: the current items in this store) sorting? (item: HorizontalPodAutoscaler) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_36","title":"Returns","text":"HorizontalPodAutoscaler[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? HorizontalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<HorizontalPodAutoscaler>
item HorizontalPodAutoscaler data PartialObjectDeep<HorizontalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_41","title":"Returns","text":"Promise<HorizontalPodAutoscaler>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<HorizontalPodAutoscaler>
item HorizontalPodAutoscaler request () => Promise<HorizontalPodAutoscaler>"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#returns_43","title":"Returns","text":"Promise<HorizontalPodAutoscaler>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/","title":"Renderer.K8sApi.IngressClassStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / IngressClassStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#class-ingressclassstore","title":"Class: IngressClassStore","text":"Renderer.K8sApi.IngressClassStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<IngressClass, IngressClassApi>\u21b3 IngressClassStore
\u2022 new IngressClassStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api IngressClassApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<IngressClass, IngressClassApi>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#api","title":"api","text":"\u2022 Readonly api: IngressClassApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: IngressClass) => string
\u25b8 (item): string
item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, IngressClassStatus, IngressClassSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#items","title":"items","text":"\u2022 items: IObservableArray<IngressClass>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<IngressClass, void, undefined>
Generator<IngressClass, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<IngressClass>
params Object params.name string params.namespace? string data? PartialObjectDeep<IngressClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_6","title":"Returns","text":"Promise<IngressClass>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | IngressClass>
params Object params.name string params.namespace? string data? PartialObjectDeep<IngressClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_7","title":"Returns","text":"Promise<null | IngressClass>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): IngressClass[]
items IngressClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_8","title":"Returns","text":"IngressClass[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): IngressClass[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_9","title":"Returns","text":"IngressClass[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | IngressClass
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_10","title":"Returns","text":"undefined | IngressClass
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): IngressClass[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_11","title":"Returns","text":"IngressClass[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | IngressClass
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_12","title":"Returns","text":"undefined | IngressClass
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | IngressClass
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_13","title":"Returns","text":"undefined | IngressClass
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getitems","title":"getItems","text":"\u25b8 getItems(): IngressClass[]
IngressClass[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? IngressClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#load","title":"load","text":"\u25b8 load(params): Promise<IngressClass>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_19","title":"Returns","text":"Promise<IngressClass>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | IngressClass[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_20","title":"Returns","text":"Promise<undefined | IngressClass[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<IngressClass>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_21","title":"Returns","text":"Promise<IngressClass>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | IngressClass>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_22","title":"Returns","text":"Promise<null | IngressClass>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<IngressClass[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_23","title":"Returns","text":"Promise<IngressClass[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): IngressClass[]
partialItems IngressClass[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_24","title":"Returns","text":"IngressClass[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<IngressClass>
item IngressClass patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_25","title":"Returns","text":"Promise<IngressClass>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): IngressClass[]
items IngressClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_26","title":"Returns","text":"IngressClass[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | IngressClass[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_27","title":"Returns","text":"Promise<undefined | IngressClass[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item IngressClass request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items IngressClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#select","title":"select","text":"\u25b8 select(item): void
item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): IngressClass[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? IngressClass[] the items to be sorted (default: the current items in this store) sorting? (item: IngressClass) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_36","title":"Returns","text":"IngressClass[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? IngressClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item IngressClass"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<IngressClass>
item IngressClass data PartialObjectDeep<IngressClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_41","title":"Returns","text":"Promise<IngressClass>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<IngressClass>
item IngressClass request () => Promise<IngressClass>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#returns_43","title":"Returns","text":"Promise<IngressClass>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/","title":"Renderer.K8sApi.IngressStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / IngressStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#class-ingressstore","title":"Class: IngressStore","text":"Renderer.K8sApi.IngressStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<Ingress, IngressApi>\u21b3 IngressStore
\u2022 new IngressStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api IngressApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<Ingress, IngressApi>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#api","title":"api","text":"\u2022 Readonly api: IngressApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: Ingress) => string
\u25b8 (item): string
item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, IngressStatus, IngressSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#items","title":"items","text":"\u2022 items: IObservableArray<Ingress>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<Ingress, void, undefined>
Generator<Ingress, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<Ingress>
params Object params.name string params.namespace? string data? PartialObjectDeep<Ingress, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_6","title":"Returns","text":"Promise<Ingress>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | Ingress>
params Object params.name string params.namespace? string data? PartialObjectDeep<Ingress, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_7","title":"Returns","text":"Promise<null | Ingress>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): Ingress[]
items Ingress[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_8","title":"Returns","text":"Ingress[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): Ingress[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_9","title":"Returns","text":"Ingress[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | Ingress
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_10","title":"Returns","text":"undefined | Ingress
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): Ingress[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_11","title":"Returns","text":"Ingress[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | Ingress
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_12","title":"Returns","text":"undefined | Ingress
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | Ingress
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_13","title":"Returns","text":"undefined | Ingress
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getitems","title":"getItems","text":"\u25b8 getItems(): Ingress[]
Ingress[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? Ingress[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#load","title":"load","text":"\u25b8 load(params): Promise<Ingress>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_19","title":"Returns","text":"Promise<Ingress>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Ingress[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_20","title":"Returns","text":"Promise<undefined | Ingress[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<Ingress>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_21","title":"Returns","text":"Promise<Ingress>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | Ingress>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_22","title":"Returns","text":"Promise<null | Ingress>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Ingress[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_23","title":"Returns","text":"Promise<Ingress[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Ingress[]
partialItems Ingress[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_24","title":"Returns","text":"Ingress[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<Ingress>
item Ingress patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_25","title":"Returns","text":"Promise<Ingress>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): Ingress[]
items Ingress[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_26","title":"Returns","text":"Ingress[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | Ingress[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_27","title":"Returns","text":"Promise<undefined | Ingress[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item Ingress request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items Ingress[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#select","title":"select","text":"\u25b8 select(item): void
item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): Ingress[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? Ingress[] the items to be sorted (default: the current items in this store) sorting? (item: Ingress) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_36","title":"Returns","text":"Ingress[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? Ingress[]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<Ingress>
item Ingress data PartialObjectDeep<Ingress, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_41","title":"Returns","text":"Promise<Ingress>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<Ingress>
item Ingress request () => Promise<Ingress>"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#returns_43","title":"Returns","text":"Promise<Ingress>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/","title":"Renderer.K8sApi.JobStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / JobStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#class-jobstore","title":"Class: JobStore","text":"Renderer.K8sApi.JobStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<Job, JobApi>\u21b3 JobStore
\u2022 new JobStore(dependencies, api, opts?)
dependencies Dependencies api JobApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#overrides","title":"Overrides","text":"KubeObjectStore<Job, JobApi\\>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#api","title":"api","text":"\u2022 Readonly api: JobApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: Job) => string
\u25b8 (item): string
item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: Dependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, JobStatus, JobSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#items","title":"items","text":"\u2022 items: IObservableArray<Job>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<Job, void, undefined>
Generator<Job, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<Job>
params Object params.name string params.namespace? string data? PartialObjectDeep<Job, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_6","title":"Returns","text":"Promise<Job>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | Job>
params Object params.name string params.namespace? string data? PartialObjectDeep<Job, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_7","title":"Returns","text":"Promise<null | Job>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): Job[]
items Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_8","title":"Returns","text":"Job[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): Job[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_9","title":"Returns","text":"Job[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | Job
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_10","title":"Returns","text":"undefined | Job
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): Job[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_11","title":"Returns","text":"Job[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | Job
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_12","title":"Returns","text":"undefined | Job
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | Job
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_13","title":"Returns","text":"undefined | Job
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getchildpods","title":"getChildPods","text":"\u25b8 getChildPods(job): Pod[]
Deprecated
Switch to using getPodsByOwnerId directly
job Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_14","title":"Returns","text":"Pod[]
\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_15","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getitems","title":"getItems","text":"\u25b8 getItems(): Job[]
Job[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getjobsbyowner","title":"getJobsByOwner","text":"\u25b8 getJobsByOwner(cronJob): Job[]
cronJob CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_17","title":"Returns","text":"Job[]
\u25b8 getStatuses(jobs?): Object
jobs? Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_18","title":"Returns","text":"Object
failed number pending number running number succeeded number"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_20","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_21","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#load","title":"load","text":"\u25b8 load(params): Promise<Job>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_22","title":"Returns","text":"Promise<Job>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Job[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_23","title":"Returns","text":"Promise<undefined | Job[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<Job>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_24","title":"Returns","text":"Promise<Job>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | Job>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_25","title":"Returns","text":"Promise<null | Job>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Job[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_26","title":"Returns","text":"Promise<Job[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Job[]
partialItems Job[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_27","title":"Returns","text":"Job[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<Job>
item Job patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_28","title":"Returns","text":"Promise<Job>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): Job[]
items Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_29","title":"Returns","text":"Job[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | Job[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_30","title":"Returns","text":"Promise<undefined | Job[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_31","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item Job request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_32","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_33","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_36","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#select","title":"select","text":"\u25b8 select(item): void
item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): Job[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? Job[] the items to be sorted (default: the current items in this store) sorting? (item: Job) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_39","title":"Returns","text":"Job[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_40","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_41","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? Job[]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_42","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item Job"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_43","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<Job>
item Job data PartialObjectDeep<Job, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_44","title":"Returns","text":"Promise<Job>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<Job>
item Job request () => Promise<Job>"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#returns_46","title":"Returns","text":"Promise<Job>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/","title":"Renderer.K8sApi.LimitRangesStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / LimitRangesStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#class-limitrangesstore","title":"Class: LimitRangesStore","text":"Renderer.K8sApi.LimitRangesStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<LimitRange, LimitRangeApi>\u21b3 LimitRangesStore
\u2022 new LimitRangesStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api LimitRangeApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<LimitRange, LimitRangeApi>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#api","title":"api","text":"\u2022 Readonly api: LimitRangeApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: LimitRange) => string
\u25b8 (item): string
item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, void, LimitRangeSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#items","title":"items","text":"\u2022 items: IObservableArray<LimitRange>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<LimitRange, void, undefined>
Generator<LimitRange, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<LimitRange>
params Object params.name string params.namespace? string data? PartialObjectDeep<LimitRange, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_6","title":"Returns","text":"Promise<LimitRange>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | LimitRange>
params Object params.name string params.namespace? string data? PartialObjectDeep<LimitRange, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_7","title":"Returns","text":"Promise<null | LimitRange>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): LimitRange[]
items LimitRange[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_8","title":"Returns","text":"LimitRange[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): LimitRange[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_9","title":"Returns","text":"LimitRange[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | LimitRange
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_10","title":"Returns","text":"undefined | LimitRange
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): LimitRange[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_11","title":"Returns","text":"LimitRange[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | LimitRange
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_12","title":"Returns","text":"undefined | LimitRange
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | LimitRange
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_13","title":"Returns","text":"undefined | LimitRange
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getitems","title":"getItems","text":"\u25b8 getItems(): LimitRange[]
LimitRange[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? LimitRange[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#load","title":"load","text":"\u25b8 load(params): Promise<LimitRange>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_19","title":"Returns","text":"Promise<LimitRange>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | LimitRange[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_20","title":"Returns","text":"Promise<undefined | LimitRange[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<LimitRange>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_21","title":"Returns","text":"Promise<LimitRange>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | LimitRange>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_22","title":"Returns","text":"Promise<null | LimitRange>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<LimitRange[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_23","title":"Returns","text":"Promise<LimitRange[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): LimitRange[]
partialItems LimitRange[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_24","title":"Returns","text":"LimitRange[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<LimitRange>
item LimitRange patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_25","title":"Returns","text":"Promise<LimitRange>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): LimitRange[]
items LimitRange[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_26","title":"Returns","text":"LimitRange[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | LimitRange[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_27","title":"Returns","text":"Promise<undefined | LimitRange[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item LimitRange request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items LimitRange[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#select","title":"select","text":"\u25b8 select(item): void
item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): LimitRange[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? LimitRange[] the items to be sorted (default: the current items in this store) sorting? (item: LimitRange) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_36","title":"Returns","text":"LimitRange[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? LimitRange[]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<LimitRange>
item LimitRange data PartialObjectDeep<LimitRange, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_41","title":"Returns","text":"Promise<LimitRange>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<LimitRange>
item LimitRange request () => Promise<LimitRange>"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#returns_43","title":"Returns","text":"Promise<LimitRange>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/","title":"Renderer.K8sApi.NamespaceStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / NamespaceStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#class-namespacestore","title":"Class: NamespaceStore","text":"Renderer.K8sApi.NamespaceStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<Namespace, NamespaceApi>\u21b3 NamespaceStore
\u2022 new NamespaceStore(dependencies, api)
dependencies Dependencies api NamespaceApi"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#overrides","title":"Overrides","text":"KubeObjectStore<Namespace, NamespaceApi\\>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#api","title":"api","text":"\u2022 Readonly api: NamespaceApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: Namespace) => string
\u25b8 (item): string
item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: Dependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, NamespaceStatus, NamespaceSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#items","title":"items","text":"\u2022 items: IObservableArray<Namespace>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectnamespaces","title":"selectNamespaces","text":"\u2022 selectNamespaces: (namespace: string | string[]) => void
\u25b8 (namespace): void
namespace string | string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_1","title":"Returns","text":"void
\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#allowednamespaces","title":"allowedNamespaces","text":"\u2022 get allowedNamespaces(): string[]
Deprecated
This doesn't contain the namespaces from cluster settings or from cluster context
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_2","title":"Returns","text":"string[]
\u2022 get areAllSelectedImplicitly(): boolean
Is true when the the set of namespace names selected is implicitly all
Namely, this will be true if the user has deselected all namespaces from the filter or if the user has clicked the \"All Namespaces\" option
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_3","title":"Returns","text":"boolean
\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#contextnamespaces","title":"contextNamespaces","text":"\u2022 get contextNamespaces(): string[]
The list of selected namespace names (for filtering)
Deprecated
This doesn't contain the namespaces from cluster settings or from cluster context
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_5","title":"Returns","text":"string[]
\u2022 get hasAllContexts(): boolean
Is true if all available namespaces are selected, otherwise false
boolean
\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectednames","title":"selectedNames","text":"\u2022 get selectedNames(): Set<string>
The set of select namespace names (for filtering)
Deprecated
This doesn't contain the namespaces from cluster settings or from cluster context
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_9","title":"Returns","text":"Set<string>
\u25b8 [iterator](): Generator<Namespace, void, undefined>
Generator<Namespace, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_11","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#clearselected","title":"clearSelected","text":"\u25b8 clearSelected(namespaces?): void
namespaces? string | string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_12","title":"Returns","text":"void
\u25b8 create(params, data?): Promise<Namespace>
params Object params.name string params.namespace? string data? PartialObjectDeep<Namespace, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_13","title":"Returns","text":"Promise<Namespace>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | Namespace>
params Object params.name string params.namespace? string data? PartialObjectDeep<Namespace, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_14","title":"Returns","text":"Promise<null | Namespace>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): Namespace[]
items Namespace[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_15","title":"Returns","text":"Namespace[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): Namespace[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_16","title":"Returns","text":"Namespace[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | Namespace
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_17","title":"Returns","text":"undefined | Namespace
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): Namespace[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_18","title":"Returns","text":"Namespace[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | Namespace
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_19","title":"Returns","text":"undefined | Namespace
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | Namespace
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_20","title":"Returns","text":"undefined | Namespace
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_21","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getitems","title":"getItems","text":"\u25b8 getItems(): Namespace[]
Namespace[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getnamespacetree","title":"getNamespaceTree","text":"\u25b8 getNamespaceTree(root): NamespaceTree
root Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_23","title":"Returns","text":"NamespaceTree
\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hascontext","title":"hasContext","text":"\u25b8 hasContext(namespaces): boolean
Checks if namespace names are selected for filtering
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_15","title":"Parameters","text":"Name Type Descriptionnamespaces string | string[] One or several names of namespaces to check if they are selected"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_25","title":"Returns","text":"boolean
true if all the provided names are selected
\u25b8 isSelected(item): boolean
item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_26","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? Namespace[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_27","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#load","title":"load","text":"\u25b8 load(params): Promise<Namespace>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_28","title":"Returns","text":"Promise<Namespace>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Namespace[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_29","title":"Returns","text":"Promise<undefined | Namespace[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<Namespace>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_30","title":"Returns","text":"Promise<Namespace>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | Namespace>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_31","title":"Returns","text":"Promise<null | Namespace>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(params): Promise<Namespace[]>
params KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_32","title":"Returns","text":"Promise<Namespace[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Namespace[]
partialItems Namespace[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_33","title":"Returns","text":"Namespace[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#oncontextchange","title":"onContextChange","text":"\u25b8 onContextChange(callback, opts?): IReactionDisposer
callback (namespaces: string[]) => void opts? Object opts.fireImmediately? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_34","title":"Returns","text":"IReactionDisposer
\u25b8 patch(item, patch): Promise<Namespace>
item Namespace patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_35","title":"Returns","text":"Promise<Namespace>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): Namespace[]
items Namespace[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_36","title":"Returns","text":"Namespace[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | Namespace[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_37","title":"Returns","text":"Promise<undefined | Namespace[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_38","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item Namespace request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_39","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items Namespace[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_40","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_43","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#select","title":"select","text":"\u25b8 select(item): void
item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_45","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectall","title":"selectAll","text":"\u25b8 selectAll(): void
Selects all available namespaces.
Note: If new namespaces appear in the future those will be selected too
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_46","title":"Returns","text":"void
\u25b8 selectSingle(namespace): void
Makes the given namespace the sole selected namespace
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_33","title":"Parameters","text":"Name Typenamespace string"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_47","title":"Returns","text":"void
\u25b8 Protected sortItems(items?, sorting?, order?): Namespace[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? Namespace[] the items to be sorted (default: the current items in this store) sorting? (item: Namespace) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_48","title":"Returns","text":"Namespace[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(): (...args: T) => void"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_49","title":"Returns","text":"
fn
\u25b8 <T>(...args): void
A function that does nothing
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#type-parameters","title":"Type parameters","text":"Name TypeT extends any[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#parameters_35","title":"Parameters","text":"Name Type ...args T"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_50","title":"Returns","text":"void
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleall","title":"toggleAll","text":"\u25b8 toggleAll(selectAll?): void
This function selects all namespaces implicitly.
NOTE: does not toggle any namespaces
Deprecated
Use NamespaceStore.selectAll instead.
selectAll? boolean NOT USED"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_51","title":"Returns","text":"void
\u25b8 toggleContext(namespaces): void
Acts like toggleSingle but can work on several at a time
namespaces string | string[] One or many names of namespaces to select"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_52","title":"Returns","text":"void
\u25b8 toggleSelection(item): void
item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_53","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? Namespace[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_54","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#togglesingle","title":"toggleSingle","text":"\u25b8 toggleSingle(namespace): void
Toggles the selection state of namespace. Namely, if it was previously specifically or implicitly selected then after this call it will be explicitly deselected.
namespace string The name of a namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_55","title":"Returns","text":"void
\u25b8 unselect(item): void
item Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_56","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<Namespace>
item Namespace data PartialObjectDeep<Namespace, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_57","title":"Returns","text":"Promise<Namespace>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<Namespace>
item Namespace request () => Promise<Namespace>"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#returns_59","title":"Returns","text":"Promise<Namespace>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/","title":"Renderer.K8sApi.NetworkPolicyStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / NetworkPolicyStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#class-networkpolicystore","title":"Class: NetworkPolicyStore","text":"Renderer.K8sApi.NetworkPolicyStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<NetworkPolicy, NetworkPolicyApi>\u21b3 NetworkPolicyStore
\u2022 new NetworkPolicyStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api NetworkPolicyApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<NetworkPolicy, NetworkPolicyApi>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#api","title":"api","text":"\u2022 Readonly api: NetworkPolicyApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: NetworkPolicy) => string
\u25b8 (item): string
item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, void, NetworkPolicySpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#items","title":"items","text":"\u2022 items: IObservableArray<NetworkPolicy>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<NetworkPolicy, void, undefined>
Generator<NetworkPolicy, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<NetworkPolicy>
params Object params.name string params.namespace? string data? PartialObjectDeep<NetworkPolicy, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_6","title":"Returns","text":"Promise<NetworkPolicy>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | NetworkPolicy>
params Object params.name string params.namespace? string data? PartialObjectDeep<NetworkPolicy, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_7","title":"Returns","text":"Promise<null | NetworkPolicy>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): NetworkPolicy[]
items NetworkPolicy[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_8","title":"Returns","text":"NetworkPolicy[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): NetworkPolicy[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_9","title":"Returns","text":"NetworkPolicy[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | NetworkPolicy
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_10","title":"Returns","text":"undefined | NetworkPolicy
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): NetworkPolicy[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_11","title":"Returns","text":"NetworkPolicy[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | NetworkPolicy
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_12","title":"Returns","text":"undefined | NetworkPolicy
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | NetworkPolicy
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_13","title":"Returns","text":"undefined | NetworkPolicy
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getitems","title":"getItems","text":"\u25b8 getItems(): NetworkPolicy[]
NetworkPolicy[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? NetworkPolicy[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#load","title":"load","text":"\u25b8 load(params): Promise<NetworkPolicy>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_19","title":"Returns","text":"Promise<NetworkPolicy>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | NetworkPolicy[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_20","title":"Returns","text":"Promise<undefined | NetworkPolicy[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<NetworkPolicy>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_21","title":"Returns","text":"Promise<NetworkPolicy>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | NetworkPolicy>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_22","title":"Returns","text":"Promise<null | NetworkPolicy>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<NetworkPolicy[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_23","title":"Returns","text":"Promise<NetworkPolicy[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): NetworkPolicy[]
partialItems NetworkPolicy[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_24","title":"Returns","text":"NetworkPolicy[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<NetworkPolicy>
item NetworkPolicy patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_25","title":"Returns","text":"Promise<NetworkPolicy>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): NetworkPolicy[]
items NetworkPolicy[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_26","title":"Returns","text":"NetworkPolicy[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | NetworkPolicy[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_27","title":"Returns","text":"Promise<undefined | NetworkPolicy[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item NetworkPolicy request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items NetworkPolicy[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#select","title":"select","text":"\u25b8 select(item): void
item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): NetworkPolicy[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? NetworkPolicy[] the items to be sorted (default: the current items in this store) sorting? (item: NetworkPolicy) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_36","title":"Returns","text":"NetworkPolicy[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? NetworkPolicy[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item NetworkPolicy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<NetworkPolicy>
item NetworkPolicy data PartialObjectDeep<NetworkPolicy, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_41","title":"Returns","text":"Promise<NetworkPolicy>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<NetworkPolicy>
item NetworkPolicy request () => Promise<NetworkPolicy>"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#returns_43","title":"Returns","text":"Promise<NetworkPolicy>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/","title":"Renderer.K8sApi.NodesStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / NodesStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#class-nodesstore","title":"Class: NodesStore","text":"Renderer.K8sApi.NodesStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<Node, NodeApi>\u21b3 NodesStore
\u2022 new NodesStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api NodeApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#overrides","title":"Overrides","text":"KubeObjectStore<Node, NodeApi\\>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#api","title":"api","text":"\u2022 Readonly api: NodeApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: Node) => string
\u25b8 (item): string
item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, NodeStatus, NodeSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#items","title":"items","text":"\u2022 items: IObservableArray<Node>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#masternodes","title":"masterNodes","text":"\u2022 get masterNodes(): Node[]
Node[]
\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#workernodes","title":"workerNodes","text":"\u2022 get workerNodes(): Node[]
Node[]
\u25b8 [iterator](): Generator<Node, void, undefined>
Generator<Node, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_7","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<Node>
params Object params.name string params.namespace? string data? PartialObjectDeep<Node, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_8","title":"Returns","text":"Promise<Node>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | Node>
params Object params.name string params.namespace? string data? PartialObjectDeep<Node, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_9","title":"Returns","text":"Promise<null | Node>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): Node[]
items Node[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_10","title":"Returns","text":"Node[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): Node[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_11","title":"Returns","text":"Node[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | Node
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_12","title":"Returns","text":"undefined | Node
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): Node[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_13","title":"Returns","text":"Node[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | Node
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_14","title":"Returns","text":"undefined | Node
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | Node
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_15","title":"Returns","text":"undefined | Node
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_16","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getitems","title":"getItems","text":"\u25b8 getItems(): Node[]
Node[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getwarningscount","title":"getWarningsCount","text":"\u25b8 getWarningsCount(): number
number
\u25b8 isSelected(item): boolean
item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_20","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? Node[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_21","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#load","title":"load","text":"\u25b8 load(params): Promise<Node>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_22","title":"Returns","text":"Promise<Node>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Node[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_23","title":"Returns","text":"Promise<undefined | Node[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<Node>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_24","title":"Returns","text":"Promise<Node>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | Node>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_25","title":"Returns","text":"Promise<null | Node>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Node[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_26","title":"Returns","text":"Promise<Node[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Node[]
partialItems Node[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_27","title":"Returns","text":"Node[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<Node>
item Node patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_28","title":"Returns","text":"Promise<Node>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): Node[]
items Node[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_29","title":"Returns","text":"Node[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | Node[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_30","title":"Returns","text":"Promise<undefined | Node[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_31","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item Node request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_32","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items Node[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_33","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_36","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#select","title":"select","text":"\u25b8 select(item): void
item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): Node[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? Node[] the items to be sorted (default: the current items in this store) sorting? (item: Node) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_39","title":"Returns","text":"Node[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_40","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_41","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? Node[]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_42","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item Node"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_43","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<Node>
item Node data PartialObjectDeep<Node, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_44","title":"Returns","text":"Promise<Node>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<Node>
item Node request () => Promise<Node>"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#returns_46","title":"Returns","text":"Promise<Node>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/","title":"Renderer.K8sApi.PersistentVolumesStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / PersistentVolumesStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#class-persistentvolumesstore","title":"Class: PersistentVolumesStore","text":"Renderer.K8sApi.PersistentVolumesStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<PersistentVolume, PersistentVolumeApi>\u21b3 PersistentVolumesStore
\u2022 new PersistentVolumesStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api PersistentVolumeApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<PersistentVolume, PersistentVolumeApi>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#api","title":"api","text":"\u2022 Readonly api: PersistentVolumeApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: PersistentVolume) => string
\u25b8 (item): string
item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, PersistentVolumeStatus, PersistentVolumeSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#items","title":"items","text":"\u2022 items: IObservableArray<PersistentVolume>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<PersistentVolume, void, undefined>
Generator<PersistentVolume, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<PersistentVolume>
params Object params.name string params.namespace? string data? PartialObjectDeep<PersistentVolume, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_6","title":"Returns","text":"Promise<PersistentVolume>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | PersistentVolume>
params Object params.name string params.namespace? string data? PartialObjectDeep<PersistentVolume, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_7","title":"Returns","text":"Promise<null | PersistentVolume>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): PersistentVolume[]
items PersistentVolume[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_8","title":"Returns","text":"PersistentVolume[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): PersistentVolume[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_9","title":"Returns","text":"PersistentVolume[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | PersistentVolume
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_10","title":"Returns","text":"undefined | PersistentVolume
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): PersistentVolume[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_11","title":"Returns","text":"PersistentVolume[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | PersistentVolume
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_12","title":"Returns","text":"undefined | PersistentVolume
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | PersistentVolume
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_13","title":"Returns","text":"undefined | PersistentVolume
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbystorageclass","title":"getByStorageClass","text":"\u25b8 getByStorageClass(storageClass): PersistentVolume[]
storageClass StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_14","title":"Returns","text":"PersistentVolume[]
\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_15","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getitems","title":"getItems","text":"\u25b8 getItems(): PersistentVolume[]
PersistentVolume[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? PersistentVolume[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_19","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#load","title":"load","text":"\u25b8 load(params): Promise<PersistentVolume>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_20","title":"Returns","text":"Promise<PersistentVolume>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | PersistentVolume[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_21","title":"Returns","text":"Promise<undefined | PersistentVolume[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<PersistentVolume>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_22","title":"Returns","text":"Promise<PersistentVolume>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | PersistentVolume>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_23","title":"Returns","text":"Promise<null | PersistentVolume>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<PersistentVolume[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_24","title":"Returns","text":"Promise<PersistentVolume[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): PersistentVolume[]
partialItems PersistentVolume[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_25","title":"Returns","text":"PersistentVolume[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<PersistentVolume>
item PersistentVolume patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_26","title":"Returns","text":"Promise<PersistentVolume>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): PersistentVolume[]
items PersistentVolume[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_27","title":"Returns","text":"PersistentVolume[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | PersistentVolume[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_28","title":"Returns","text":"Promise<undefined | PersistentVolume[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item PersistentVolume request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items PersistentVolume[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_31","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_34","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#select","title":"select","text":"\u25b8 select(item): void
item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_36","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): PersistentVolume[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? PersistentVolume[] the items to be sorted (default: the current items in this store) sorting? (item: PersistentVolume) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_37","title":"Returns","text":"PersistentVolume[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_38","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? PersistentVolume[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item PersistentVolume"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_41","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<PersistentVolume>
item PersistentVolume data PartialObjectDeep<PersistentVolume, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_42","title":"Returns","text":"Promise<PersistentVolume>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<PersistentVolume>
item PersistentVolume request () => Promise<PersistentVolume>"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#returns_44","title":"Returns","text":"Promise<PersistentVolume>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/","title":"Renderer.K8sApi.PodDisruptionBudgetsStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / PodDisruptionBudgetsStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#class-poddisruptionbudgetsstore","title":"Class: PodDisruptionBudgetsStore","text":"Renderer.K8sApi.PodDisruptionBudgetsStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<PodDisruptionBudget, PodDisruptionBudgetApi>\u21b3 PodDisruptionBudgetsStore
\u2022 new PodDisruptionBudgetsStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api PodDisruptionBudgetApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<PodDisruptionBudget, PodDisruptionBudgetApi>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#api","title":"api","text":"\u2022 Readonly api: PodDisruptionBudgetApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: PodDisruptionBudget) => string
\u25b8 (item): string
item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, V1Beta1PodDisruptionBudgetStatus | V1PodDisruptionBudgetStatus, PodDisruptionBudgetSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#items","title":"items","text":"\u2022 items: IObservableArray<PodDisruptionBudget>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<PodDisruptionBudget, void, undefined>
Generator<PodDisruptionBudget, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<PodDisruptionBudget>
params Object params.name string params.namespace? string data? PartialObjectDeep<PodDisruptionBudget, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_6","title":"Returns","text":"Promise<PodDisruptionBudget>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | PodDisruptionBudget>
params Object params.name string params.namespace? string data? PartialObjectDeep<PodDisruptionBudget, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_7","title":"Returns","text":"Promise<null | PodDisruptionBudget>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): PodDisruptionBudget[]
items PodDisruptionBudget[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_8","title":"Returns","text":"PodDisruptionBudget[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): PodDisruptionBudget[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_9","title":"Returns","text":"PodDisruptionBudget[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | PodDisruptionBudget
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_10","title":"Returns","text":"undefined | PodDisruptionBudget
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): PodDisruptionBudget[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_11","title":"Returns","text":"PodDisruptionBudget[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | PodDisruptionBudget
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_12","title":"Returns","text":"undefined | PodDisruptionBudget
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | PodDisruptionBudget
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_13","title":"Returns","text":"undefined | PodDisruptionBudget
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getitems","title":"getItems","text":"\u25b8 getItems(): PodDisruptionBudget[]
PodDisruptionBudget[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? PodDisruptionBudget[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#load","title":"load","text":"\u25b8 load(params): Promise<PodDisruptionBudget>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_19","title":"Returns","text":"Promise<PodDisruptionBudget>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | PodDisruptionBudget[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_20","title":"Returns","text":"Promise<undefined | PodDisruptionBudget[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<PodDisruptionBudget>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_21","title":"Returns","text":"Promise<PodDisruptionBudget>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | PodDisruptionBudget>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_22","title":"Returns","text":"Promise<null | PodDisruptionBudget>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<PodDisruptionBudget[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_23","title":"Returns","text":"Promise<PodDisruptionBudget[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): PodDisruptionBudget[]
partialItems PodDisruptionBudget[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_24","title":"Returns","text":"PodDisruptionBudget[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<PodDisruptionBudget>
item PodDisruptionBudget patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_25","title":"Returns","text":"Promise<PodDisruptionBudget>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): PodDisruptionBudget[]
items PodDisruptionBudget[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_26","title":"Returns","text":"PodDisruptionBudget[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | PodDisruptionBudget[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_27","title":"Returns","text":"Promise<undefined | PodDisruptionBudget[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item PodDisruptionBudget request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items PodDisruptionBudget[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#select","title":"select","text":"\u25b8 select(item): void
item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): PodDisruptionBudget[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? PodDisruptionBudget[] the items to be sorted (default: the current items in this store) sorting? (item: PodDisruptionBudget) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_36","title":"Returns","text":"PodDisruptionBudget[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? PodDisruptionBudget[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item PodDisruptionBudget"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<PodDisruptionBudget>
item PodDisruptionBudget data PartialObjectDeep<PodDisruptionBudget, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_41","title":"Returns","text":"Promise<PodDisruptionBudget>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<PodDisruptionBudget>
item PodDisruptionBudget request () => Promise<PodDisruptionBudget>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#returns_43","title":"Returns","text":"Promise<PodDisruptionBudget>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/","title":"Renderer.K8sApi.PodsStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / PodsStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#class-podsstore","title":"Class: PodsStore","text":"Renderer.K8sApi.PodsStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<Pod, PodApi>\u21b3 PodsStore
\u2022 new PodsStore(dependencies, api, opts?)
dependencies PodStoreDependencies api PodApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#overrides","title":"Overrides","text":"KubeObjectStore<Pod, PodApi\\>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#api","title":"api","text":"\u2022 Readonly api: PodApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: Pod) => string
\u25b8 (item): string
item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: PodStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, PodStatus, PodSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#items","title":"items","text":"\u2022 items: IObservableArray<Pod>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#kubemetrics","title":"kubeMetrics","text":"\u2022 Readonly kubeMetrics: IObservableArray<PodMetrics>
\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<Pod, void, undefined>
Generator<Pod, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<Pod>
params Object params.name string params.namespace? string data? PartialObjectDeep<Pod, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_6","title":"Returns","text":"Promise<Pod>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | Pod>
params Object params.name string params.namespace? string data? PartialObjectDeep<Pod, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_7","title":"Returns","text":"Promise<null | Pod>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): Pod[]
items Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_8","title":"Returns","text":"Pod[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): Pod[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_9","title":"Returns","text":"Pod[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | Pod
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_10","title":"Returns","text":"undefined | Pod
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): Pod[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_11","title":"Returns","text":"Pod[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | Pod
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_12","title":"Returns","text":"undefined | Pod
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | Pod
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_13","title":"Returns","text":"undefined | Pod
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getitems","title":"getItems","text":"\u25b8 getItems(): Pod[]
Pod[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodkubemetrics","title":"getPodKubeMetrics","text":"\u25b8 getPodKubeMetrics(pod): Object
pod Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_16","title":"Returns","text":"Object
cpu number memory number"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodsbynode","title":"getPodsByNode","text":"\u25b8 getPodsByNode(node): Pod[]
node string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_17","title":"Returns","text":"Pod[]
\u25b8 getPodsByOwner(workload): Pod[]
workload KubeObject<NamespaceScopedMetadata, unknown, unknown>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_18","title":"Returns","text":"Pod[]
\u25b8 getPodsByOwnerId(workloadId): Pod[]
workloadId string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_19","title":"Returns","text":"Pod[]
\u25b8 getStatuses(pods): Dictionary<number>
pods Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_20","title":"Returns","text":"Dictionary<number>
\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_22","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_23","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#load","title":"load","text":"\u25b8 load(params): Promise<Pod>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_24","title":"Returns","text":"Promise<Pod>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Pod[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_25","title":"Returns","text":"Promise<undefined | Pod[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<Pod>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_26","title":"Returns","text":"Promise<Pod>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | Pod>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_27","title":"Returns","text":"Promise<null | Pod>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Pod[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_28","title":"Returns","text":"Promise<Pod[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loadkubemetrics","title":"loadKubeMetrics","text":"\u25b8 loadKubeMetrics(namespace?): Promise<void>
namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_29","title":"Returns","text":"Promise<void>
\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Pod[]
partialItems Pod[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_30","title":"Returns","text":"Pod[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<Pod>
item Pod patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_31","title":"Returns","text":"Promise<Pod>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): Pod[]
items Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_32","title":"Returns","text":"Pod[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | Pod[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_33","title":"Returns","text":"Promise<undefined | Pod[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_34","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item Pod request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_35","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_36","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#select","title":"select","text":"\u25b8 select(item): void
item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_41","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): Pod[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? Pod[] the items to be sorted (default: the current items in this store) sorting? (item: Pod) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_42","title":"Returns","text":"Pod[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_43","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_44","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? Pod[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_45","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item Pod"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_46","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<Pod>
item Pod data PartialObjectDeep<Pod, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_47","title":"Returns","text":"Promise<Pod>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<Pod>
item Pod request () => Promise<Pod>"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#returns_49","title":"Returns","text":"Promise<Pod>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/","title":"Renderer.K8sApi.PriorityClassStoreStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / PriorityClassStoreStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#class-priorityclassstorestore","title":"Class: PriorityClassStoreStore","text":"Renderer.K8sApi.PriorityClassStoreStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<PriorityClass, PriorityClassApi>\u21b3 PriorityClassStoreStore
\u2022 new PriorityClassStoreStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api PriorityClassApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<PriorityClass, PriorityClassApi>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#api","title":"api","text":"\u2022 Readonly api: PriorityClassApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: PriorityClass) => string
\u25b8 (item): string
item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<PriorityClassData>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#items","title":"items","text":"\u2022 items: IObservableArray<PriorityClass>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<PriorityClass, void, undefined>
Generator<PriorityClass, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<PriorityClass>
params Object params.name string params.namespace? string data? PartialObjectDeep<PriorityClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_6","title":"Returns","text":"Promise<PriorityClass>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | PriorityClass>
params Object params.name string params.namespace? string data? PartialObjectDeep<PriorityClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_7","title":"Returns","text":"Promise<null | PriorityClass>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): PriorityClass[]
items PriorityClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_8","title":"Returns","text":"PriorityClass[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): PriorityClass[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_9","title":"Returns","text":"PriorityClass[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | PriorityClass
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_10","title":"Returns","text":"undefined | PriorityClass
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): PriorityClass[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_11","title":"Returns","text":"PriorityClass[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | PriorityClass
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_12","title":"Returns","text":"undefined | PriorityClass
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | PriorityClass
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_13","title":"Returns","text":"undefined | PriorityClass
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getitems","title":"getItems","text":"\u25b8 getItems(): PriorityClass[]
PriorityClass[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? PriorityClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#load","title":"load","text":"\u25b8 load(params): Promise<PriorityClass>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_19","title":"Returns","text":"Promise<PriorityClass>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | PriorityClass[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_20","title":"Returns","text":"Promise<undefined | PriorityClass[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<PriorityClass>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_21","title":"Returns","text":"Promise<PriorityClass>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | PriorityClass>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_22","title":"Returns","text":"Promise<null | PriorityClass>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<PriorityClass[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_23","title":"Returns","text":"Promise<PriorityClass[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): PriorityClass[]
partialItems PriorityClass[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_24","title":"Returns","text":"PriorityClass[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<PriorityClass>
item PriorityClass patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_25","title":"Returns","text":"Promise<PriorityClass>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): PriorityClass[]
items PriorityClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_26","title":"Returns","text":"PriorityClass[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | PriorityClass[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_27","title":"Returns","text":"Promise<undefined | PriorityClass[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item PriorityClass request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items PriorityClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#select","title":"select","text":"\u25b8 select(item): void
item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): PriorityClass[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? PriorityClass[] the items to be sorted (default: the current items in this store) sorting? (item: PriorityClass) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_36","title":"Returns","text":"PriorityClass[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? PriorityClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item PriorityClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<PriorityClass>
item PriorityClass data PartialObjectDeep<PriorityClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_41","title":"Returns","text":"Promise<PriorityClass>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<PriorityClass>
item PriorityClass request () => Promise<PriorityClass>"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#returns_43","title":"Returns","text":"Promise<PriorityClass>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/","title":"Renderer.K8sApi.ReplicaSetStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / ReplicaSetStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#class-replicasetstore","title":"Class: ReplicaSetStore","text":"Renderer.K8sApi.ReplicaSetStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<ReplicaSet, ReplicaSetApi>\u21b3 ReplicaSetStore
\u2022 new ReplicaSetStore(dependencies, api, opts?)
dependencies ReplicaSetStoreDependencies api ReplicaSetApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#overrides","title":"Overrides","text":"KubeObjectStore<ReplicaSet, ReplicaSetApi\\>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#api","title":"api","text":"\u2022 Readonly api: ReplicaSetApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: ReplicaSet) => string
\u25b8 (item): string
item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: ReplicaSetStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, ReplicaSetStatus, ReplicaSetSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#items","title":"items","text":"\u2022 items: IObservableArray<ReplicaSet>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<ReplicaSet, void, undefined>
Generator<ReplicaSet, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<ReplicaSet>
params Object params.name string params.namespace? string data? PartialObjectDeep<ReplicaSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_6","title":"Returns","text":"Promise<ReplicaSet>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | ReplicaSet>
params Object params.name string params.namespace? string data? PartialObjectDeep<ReplicaSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_7","title":"Returns","text":"Promise<null | ReplicaSet>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): ReplicaSet[]
items ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_8","title":"Returns","text":"ReplicaSet[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): ReplicaSet[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_9","title":"Returns","text":"ReplicaSet[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | ReplicaSet
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_10","title":"Returns","text":"undefined | ReplicaSet
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): ReplicaSet[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_11","title":"Returns","text":"ReplicaSet[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | ReplicaSet
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_12","title":"Returns","text":"undefined | ReplicaSet
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | ReplicaSet
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_13","title":"Returns","text":"undefined | ReplicaSet
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getchildpods","title":"getChildPods","text":"\u25b8 getChildPods(replicaSet): Pod[]
Deprecated
Switch to using getPodsByOwnerId directly
replicaSet ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_14","title":"Returns","text":"Pod[]
\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_15","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getitems","title":"getItems","text":"\u25b8 getItems(): ReplicaSet[]
ReplicaSet[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getreplicasetsbyowner","title":"getReplicaSetsByOwner","text":"\u25b8 getReplicaSetsByOwner(deployment): ReplicaSet[]
deployment Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_17","title":"Returns","text":"ReplicaSet[]
\u25b8 getStatuses(replicaSets): Object
replicaSets ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_18","title":"Returns","text":"Object
failed number pending number running number"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_20","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_21","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#load","title":"load","text":"\u25b8 load(params): Promise<ReplicaSet>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_22","title":"Returns","text":"Promise<ReplicaSet>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | ReplicaSet[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_23","title":"Returns","text":"Promise<undefined | ReplicaSet[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<ReplicaSet>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_24","title":"Returns","text":"Promise<ReplicaSet>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | ReplicaSet>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_25","title":"Returns","text":"Promise<null | ReplicaSet>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<ReplicaSet[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_26","title":"Returns","text":"Promise<ReplicaSet[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): ReplicaSet[]
partialItems ReplicaSet[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_27","title":"Returns","text":"ReplicaSet[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<ReplicaSet>
item ReplicaSet patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_28","title":"Returns","text":"Promise<ReplicaSet>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): ReplicaSet[]
items ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_29","title":"Returns","text":"ReplicaSet[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | ReplicaSet[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_30","title":"Returns","text":"Promise<undefined | ReplicaSet[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_31","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item ReplicaSet request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_32","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_33","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_36","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#select","title":"select","text":"\u25b8 select(item): void
item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): ReplicaSet[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? ReplicaSet[] the items to be sorted (default: the current items in this store) sorting? (item: ReplicaSet) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_39","title":"Returns","text":"ReplicaSet[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_40","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_41","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? ReplicaSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_42","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item ReplicaSet"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_43","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<ReplicaSet>
item ReplicaSet data PartialObjectDeep<ReplicaSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_44","title":"Returns","text":"Promise<ReplicaSet>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<ReplicaSet>
item ReplicaSet request () => Promise<ReplicaSet>"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#returns_46","title":"Returns","text":"Promise<ReplicaSet>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/","title":"Renderer.K8sApi.ResourceQuotasStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / ResourceQuotasStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#class-resourcequotasstore","title":"Class: ResourceQuotasStore","text":"Renderer.K8sApi.ResourceQuotasStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<ResourceQuota, ResourceQuotaApi>\u21b3 ResourceQuotasStore
\u2022 new ResourceQuotasStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api ResourceQuotaApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<ResourceQuota, ResourceQuotaApi>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#api","title":"api","text":"\u2022 Readonly api: ResourceQuotaApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: ResourceQuota) => string
\u25b8 (item): string
item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, ResourceQuotaStatus, ResourceQuotaSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#items","title":"items","text":"\u2022 items: IObservableArray<ResourceQuota>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<ResourceQuota, void, undefined>
Generator<ResourceQuota, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<ResourceQuota>
params Object params.name string params.namespace? string data? PartialObjectDeep<ResourceQuota, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_6","title":"Returns","text":"Promise<ResourceQuota>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | ResourceQuota>
params Object params.name string params.namespace? string data? PartialObjectDeep<ResourceQuota, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_7","title":"Returns","text":"Promise<null | ResourceQuota>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): ResourceQuota[]
items ResourceQuota[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_8","title":"Returns","text":"ResourceQuota[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): ResourceQuota[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_9","title":"Returns","text":"ResourceQuota[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | ResourceQuota
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_10","title":"Returns","text":"undefined | ResourceQuota
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): ResourceQuota[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_11","title":"Returns","text":"ResourceQuota[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | ResourceQuota
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_12","title":"Returns","text":"undefined | ResourceQuota
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | ResourceQuota
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_13","title":"Returns","text":"undefined | ResourceQuota
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getitems","title":"getItems","text":"\u25b8 getItems(): ResourceQuota[]
ResourceQuota[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? ResourceQuota[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#load","title":"load","text":"\u25b8 load(params): Promise<ResourceQuota>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_19","title":"Returns","text":"Promise<ResourceQuota>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | ResourceQuota[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_20","title":"Returns","text":"Promise<undefined | ResourceQuota[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<ResourceQuota>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_21","title":"Returns","text":"Promise<ResourceQuota>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | ResourceQuota>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_22","title":"Returns","text":"Promise<null | ResourceQuota>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<ResourceQuota[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_23","title":"Returns","text":"Promise<ResourceQuota[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): ResourceQuota[]
partialItems ResourceQuota[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_24","title":"Returns","text":"ResourceQuota[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<ResourceQuota>
item ResourceQuota patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_25","title":"Returns","text":"Promise<ResourceQuota>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): ResourceQuota[]
items ResourceQuota[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_26","title":"Returns","text":"ResourceQuota[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | ResourceQuota[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_27","title":"Returns","text":"Promise<undefined | ResourceQuota[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item ResourceQuota request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items ResourceQuota[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#select","title":"select","text":"\u25b8 select(item): void
item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): ResourceQuota[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? ResourceQuota[] the items to be sorted (default: the current items in this store) sorting? (item: ResourceQuota) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_36","title":"Returns","text":"ResourceQuota[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? ResourceQuota[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item ResourceQuota"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<ResourceQuota>
item ResourceQuota data PartialObjectDeep<ResourceQuota, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_41","title":"Returns","text":"Promise<ResourceQuota>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<ResourceQuota>
item ResourceQuota request () => Promise<ResourceQuota>"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#returns_43","title":"Returns","text":"Promise<ResourceQuota>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/","title":"Renderer.K8sApi.RoleBindingsStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / RoleBindingsStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#class-rolebindingsstore","title":"Class: RoleBindingsStore","text":"Renderer.K8sApi.RoleBindingsStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<RoleBinding, RoleBindingApi, RoleBindingData>\u21b3 RoleBindingsStore
\u2022 new RoleBindingsStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api RoleBindingApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<RoleBinding, RoleBindingApi, RoleBindingData>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#api","title":"api","text":"\u2022 Readonly api: RoleBindingApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: RoleBinding) => string
\u25b8 (item): string
item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<RoleBindingData>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#items","title":"items","text":"\u2022 items: IObservableArray<RoleBinding>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<RoleBinding, void, undefined>
Generator<RoleBinding, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<RoleBinding>
params Object params.name string params.namespace? string data? PartialObjectDeep<RoleBinding, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_6","title":"Returns","text":"Promise<RoleBinding>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | RoleBinding>
params Object params.name string params.namespace? string data? PartialObjectDeep<RoleBinding, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_7","title":"Returns","text":"Promise<null | RoleBinding>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): RoleBinding[]
items RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_8","title":"Returns","text":"RoleBinding[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): RoleBinding[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_9","title":"Returns","text":"RoleBinding[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | RoleBinding
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_10","title":"Returns","text":"undefined | RoleBinding
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): RoleBinding[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_11","title":"Returns","text":"RoleBinding[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | RoleBinding
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_12","title":"Returns","text":"undefined | RoleBinding
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | RoleBinding
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_13","title":"Returns","text":"undefined | RoleBinding
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getitems","title":"getItems","text":"\u25b8 getItems(): RoleBinding[]
RoleBinding[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#load","title":"load","text":"\u25b8 load(params): Promise<RoleBinding>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_19","title":"Returns","text":"Promise<RoleBinding>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | RoleBinding[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_20","title":"Returns","text":"Promise<undefined | RoleBinding[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<RoleBinding>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_21","title":"Returns","text":"Promise<RoleBinding>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | RoleBinding>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_22","title":"Returns","text":"Promise<null | RoleBinding>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<RoleBinding[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_23","title":"Returns","text":"Promise<RoleBinding[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): RoleBinding[]
partialItems RoleBinding[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_24","title":"Returns","text":"RoleBinding[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<RoleBinding>
item RoleBinding patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_25","title":"Returns","text":"Promise<RoleBinding>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): RoleBinding[]
items RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_26","title":"Returns","text":"RoleBinding[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | RoleBinding[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_27","title":"Returns","text":"Promise<undefined | RoleBinding[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item RoleBinding request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removesubjects","title":"removeSubjects","text":"\u25b8 removeSubjects(roleBinding, subjectsToRemove): Promise<RoleBinding>
roleBinding RoleBinding subjectsToRemove Iterable<Subject>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_32","title":"Returns","text":"Promise<RoleBinding>
\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_34","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#select","title":"select","text":"\u25b8 select(item): void
item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_36","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items): RoleBinding[]
items RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_37","title":"Returns","text":"RoleBinding[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_38","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? RoleBinding[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item RoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_41","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<RoleBinding>
item RoleBinding data PartialObjectDeep<RoleBinding, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_42","title":"Returns","text":"Promise<RoleBinding>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<RoleBinding>
item RoleBinding request () => Promise<RoleBinding>"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_44","title":"Returns","text":"Promise<RoleBinding>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#updatesubjects","title":"updateSubjects","text":"\u25b8 updateSubjects(roleBinding, subjects): Promise<RoleBinding>
roleBinding RoleBinding subjects Subject[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#returns_45","title":"Returns","text":"Promise<RoleBinding>
@k8slens/extensions / Exports / Renderer / K8sApi / RolesStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#class-rolesstore","title":"Class: RolesStore","text":"Renderer.K8sApi.RolesStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<Role, RoleApi, RoleData>\u21b3 RolesStore
\u2022 new RolesStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api RoleApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<Role, RoleApi, RoleData>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#api","title":"api","text":"\u2022 Readonly api: RoleApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: Role) => string
\u25b8 (item): string
item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<RoleData>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#items","title":"items","text":"\u2022 items: IObservableArray<Role>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<Role, void, undefined>
Generator<Role, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<Role>
params Object params.name string params.namespace? string data? PartialObjectDeep<Role, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_6","title":"Returns","text":"Promise<Role>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | Role>
params Object params.name string params.namespace? string data? PartialObjectDeep<Role, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_7","title":"Returns","text":"Promise<null | Role>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): Role[]
items Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_8","title":"Returns","text":"Role[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): Role[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_9","title":"Returns","text":"Role[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | Role
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_10","title":"Returns","text":"undefined | Role
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): Role[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_11","title":"Returns","text":"Role[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | Role
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_12","title":"Returns","text":"undefined | Role
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | Role
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_13","title":"Returns","text":"undefined | Role
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getitems","title":"getItems","text":"\u25b8 getItems(): Role[]
Role[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#load","title":"load","text":"\u25b8 load(params): Promise<Role>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_19","title":"Returns","text":"Promise<Role>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Role[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_20","title":"Returns","text":"Promise<undefined | Role[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<Role>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_21","title":"Returns","text":"Promise<Role>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | Role>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_22","title":"Returns","text":"Promise<null | Role>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Role[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_23","title":"Returns","text":"Promise<Role[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Role[]
partialItems Role[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_24","title":"Returns","text":"Role[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<Role>
item Role patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_25","title":"Returns","text":"Promise<Role>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): Role[]
items Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_26","title":"Returns","text":"Role[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | Role[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_27","title":"Returns","text":"Promise<undefined | Role[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item Role request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#select","title":"select","text":"\u25b8 select(item): void
item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items): Role[]
items Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_36","title":"Returns","text":"Role[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? Role[]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item Role"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<Role>
item Role data PartialObjectDeep<Role, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_41","title":"Returns","text":"Promise<Role>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<Role>
item Role request () => Promise<Role>"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#returns_43","title":"Returns","text":"Promise<Role>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/","title":"Renderer.K8sApi.SecretsStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / SecretsStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#class-secretsstore","title":"Class: SecretsStore","text":"Renderer.K8sApi.SecretsStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<Secret, SecretApi, SecretData>\u21b3 SecretsStore
\u2022 new SecretsStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api SecretApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<Secret, SecretApi, SecretData>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#api","title":"api","text":"\u2022 Readonly api: SecretApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: Secret) => string
\u25b8 (item): string
item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<SecretData>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#items","title":"items","text":"\u2022 items: IObservableArray<Secret>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<Secret, void, undefined>
Generator<Secret, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<Secret>
params Object params.name string params.namespace? string data? PartialObjectDeep<Secret, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_6","title":"Returns","text":"Promise<Secret>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | Secret>
params Object params.name string params.namespace? string data? PartialObjectDeep<Secret, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_7","title":"Returns","text":"Promise<null | Secret>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): Secret[]
items Secret[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_8","title":"Returns","text":"Secret[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): Secret[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_9","title":"Returns","text":"Secret[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | Secret
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_10","title":"Returns","text":"undefined | Secret
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): Secret[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_11","title":"Returns","text":"Secret[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | Secret
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_12","title":"Returns","text":"undefined | Secret
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | Secret
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_13","title":"Returns","text":"undefined | Secret
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getitems","title":"getItems","text":"\u25b8 getItems(): Secret[]
Secret[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? Secret[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#load","title":"load","text":"\u25b8 load(params): Promise<Secret>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_19","title":"Returns","text":"Promise<Secret>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Secret[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_20","title":"Returns","text":"Promise<undefined | Secret[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<Secret>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_21","title":"Returns","text":"Promise<Secret>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | Secret>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_22","title":"Returns","text":"Promise<null | Secret>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Secret[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_23","title":"Returns","text":"Promise<Secret[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Secret[]
partialItems Secret[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_24","title":"Returns","text":"Secret[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<Secret>
item Secret patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_25","title":"Returns","text":"Promise<Secret>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): Secret[]
items Secret[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_26","title":"Returns","text":"Secret[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | Secret[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_27","title":"Returns","text":"Promise<undefined | Secret[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item Secret request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items Secret[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#select","title":"select","text":"\u25b8 select(item): void
item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): Secret[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? Secret[] the items to be sorted (default: the current items in this store) sorting? (item: Secret) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_36","title":"Returns","text":"Secret[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? Secret[]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item Secret"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<Secret>
item Secret data PartialObjectDeep<Secret, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_41","title":"Returns","text":"Promise<Secret>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<Secret>
item Secret request () => Promise<Secret>"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#returns_43","title":"Returns","text":"Promise<Secret>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/","title":"Renderer.K8sApi.ServiceAccountsStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / ServiceAccountsStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#class-serviceaccountsstore","title":"Class: ServiceAccountsStore","text":"Renderer.K8sApi.ServiceAccountsStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<ServiceAccount, ServiceAccountApi, ServiceAccountData>\u21b3 ServiceAccountsStore
\u2022 new ServiceAccountsStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api ServiceAccountApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<ServiceAccount, ServiceAccountApi, ServiceAccountData>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#api","title":"api","text":"\u2022 Readonly api: ServiceAccountApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: ServiceAccount) => string
\u25b8 (item): string
item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<ServiceAccountData>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#items","title":"items","text":"\u2022 items: IObservableArray<ServiceAccount>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<ServiceAccount, void, undefined>
Generator<ServiceAccount, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<ServiceAccount>
params Object params.name string params.namespace? string data? PartialObjectDeep<ServiceAccount, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_6","title":"Returns","text":"Promise<ServiceAccount>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params): Promise<null | ServiceAccount>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_7","title":"Returns","text":"Promise<null | ServiceAccount>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): ServiceAccount[]
items ServiceAccount[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_8","title":"Returns","text":"ServiceAccount[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): ServiceAccount[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_9","title":"Returns","text":"ServiceAccount[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | ServiceAccount
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_10","title":"Returns","text":"undefined | ServiceAccount
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): ServiceAccount[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_11","title":"Returns","text":"ServiceAccount[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | ServiceAccount
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_12","title":"Returns","text":"undefined | ServiceAccount
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | ServiceAccount
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_13","title":"Returns","text":"undefined | ServiceAccount
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getitems","title":"getItems","text":"\u25b8 getItems(): ServiceAccount[]
ServiceAccount[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? ServiceAccount[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#load","title":"load","text":"\u25b8 load(params): Promise<ServiceAccount>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_19","title":"Returns","text":"Promise<ServiceAccount>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | ServiceAccount[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_20","title":"Returns","text":"Promise<undefined | ServiceAccount[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<ServiceAccount>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_21","title":"Returns","text":"Promise<ServiceAccount>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | ServiceAccount>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_22","title":"Returns","text":"Promise<null | ServiceAccount>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<ServiceAccount[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_23","title":"Returns","text":"Promise<ServiceAccount[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): ServiceAccount[]
partialItems ServiceAccount[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_24","title":"Returns","text":"ServiceAccount[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<ServiceAccount>
item ServiceAccount patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_25","title":"Returns","text":"Promise<ServiceAccount>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): ServiceAccount[]
items ServiceAccount[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_26","title":"Returns","text":"ServiceAccount[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | ServiceAccount[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_27","title":"Returns","text":"Promise<undefined | ServiceAccount[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item ServiceAccount request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items ServiceAccount[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#select","title":"select","text":"\u25b8 select(item): void
item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): ServiceAccount[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? ServiceAccount[] the items to be sorted (default: the current items in this store) sorting? (item: ServiceAccount) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_36","title":"Returns","text":"ServiceAccount[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? ServiceAccount[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item ServiceAccount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<ServiceAccount>
item ServiceAccount data PartialObjectDeep<ServiceAccount, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_41","title":"Returns","text":"Promise<ServiceAccount>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<ServiceAccount>
item ServiceAccount request () => Promise<ServiceAccount>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#returns_43","title":"Returns","text":"Promise<ServiceAccount>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/","title":"Renderer.K8sApi.ServiceStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / ServiceStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#class-servicestore","title":"Class: ServiceStore","text":"Renderer.K8sApi.ServiceStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<Service, ServiceApi>\u21b3 ServiceStore
\u2022 new ServiceStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api ServiceApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<Service, ServiceApi>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#api","title":"api","text":"\u2022 Readonly api: ServiceApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: Service) => string
\u25b8 (item): string
item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, ServiceStatus, ServiceSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#items","title":"items","text":"\u2022 items: IObservableArray<Service>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<Service, void, undefined>
Generator<Service, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<Service>
params Object params.name string params.namespace? string data? PartialObjectDeep<Service, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_6","title":"Returns","text":"Promise<Service>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | Service>
params Object params.name string params.namespace? string data? PartialObjectDeep<Service, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_7","title":"Returns","text":"Promise<null | Service>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): Service[]
items Service[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_8","title":"Returns","text":"Service[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): Service[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_9","title":"Returns","text":"Service[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | Service
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_10","title":"Returns","text":"undefined | Service
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): Service[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_11","title":"Returns","text":"Service[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | Service
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_12","title":"Returns","text":"undefined | Service
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | Service
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_13","title":"Returns","text":"undefined | Service
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getitems","title":"getItems","text":"\u25b8 getItems(): Service[]
Service[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? Service[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#load","title":"load","text":"\u25b8 load(params): Promise<Service>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_19","title":"Returns","text":"Promise<Service>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | Service[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_20","title":"Returns","text":"Promise<undefined | Service[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<Service>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_21","title":"Returns","text":"Promise<Service>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | Service>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_22","title":"Returns","text":"Promise<null | Service>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<Service[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_23","title":"Returns","text":"Promise<Service[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): Service[]
partialItems Service[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_24","title":"Returns","text":"Service[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<Service>
item Service patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_25","title":"Returns","text":"Promise<Service>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): Service[]
items Service[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_26","title":"Returns","text":"Service[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | Service[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_27","title":"Returns","text":"Promise<undefined | Service[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item Service request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items Service[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#select","title":"select","text":"\u25b8 select(item): void
item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): Service[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? Service[] the items to be sorted (default: the current items in this store) sorting? (item: Service) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_36","title":"Returns","text":"Service[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? Service[]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item Service"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<Service>
item Service data PartialObjectDeep<Service, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_41","title":"Returns","text":"Promise<Service>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<Service>
item Service request () => Promise<Service>"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#returns_43","title":"Returns","text":"Promise<Service>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/","title":"Renderer.K8sApi.StatefulSetStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / StatefulSetStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#class-statefulsetstore","title":"Class: StatefulSetStore","text":"Renderer.K8sApi.StatefulSetStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<StatefulSet, StatefulSetApi>\u21b3 StatefulSetStore
\u2022 new StatefulSetStore(dependencies, api, opts?)
dependencies Dependencies api StatefulSetApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#overrides","title":"Overrides","text":"KubeObjectStore<StatefulSet, StatefulSetApi\\>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#api","title":"api","text":"\u2022 Readonly api: StatefulSetApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: StatefulSet) => string
\u25b8 (item): string
item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: Dependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, StatefulSetStatus, StatefulSetSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#items","title":"items","text":"\u2022 items: IObservableArray<StatefulSet>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<StatefulSet, void, undefined>
Generator<StatefulSet, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<StatefulSet>
params Object params.name string params.namespace? string data? PartialObjectDeep<StatefulSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_6","title":"Returns","text":"Promise<StatefulSet>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | StatefulSet>
params Object params.name string params.namespace? string data? PartialObjectDeep<StatefulSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_7","title":"Returns","text":"Promise<null | StatefulSet>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): StatefulSet[]
items StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_8","title":"Returns","text":"StatefulSet[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): StatefulSet[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_9","title":"Returns","text":"StatefulSet[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | StatefulSet
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_10","title":"Returns","text":"undefined | StatefulSet
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): StatefulSet[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_11","title":"Returns","text":"StatefulSet[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | StatefulSet
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_12","title":"Returns","text":"undefined | StatefulSet
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | StatefulSet
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_13","title":"Returns","text":"undefined | StatefulSet
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getchildpods","title":"getChildPods","text":"\u25b8 getChildPods(statefulSet): Pod[]
Deprecated
Switch to using getPodsByOwnerId directly
statefulSet StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_14","title":"Returns","text":"Pod[]
\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_15","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getitems","title":"getItems","text":"\u25b8 getItems(): StatefulSet[]
StatefulSet[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getstatuses","title":"getStatuses","text":"\u25b8 getStatuses(statefulSets): Object
statefulSets StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_17","title":"Returns","text":"Object
failed number pending number running number"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_19","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_20","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#load","title":"load","text":"\u25b8 load(params): Promise<StatefulSet>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_21","title":"Returns","text":"Promise<StatefulSet>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | StatefulSet[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_22","title":"Returns","text":"Promise<undefined | StatefulSet[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<StatefulSet>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_23","title":"Returns","text":"Promise<StatefulSet>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | StatefulSet>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_24","title":"Returns","text":"Promise<null | StatefulSet>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<StatefulSet[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_25","title":"Returns","text":"Promise<StatefulSet[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): StatefulSet[]
partialItems StatefulSet[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_26","title":"Returns","text":"StatefulSet[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<StatefulSet>
item StatefulSet patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_27","title":"Returns","text":"Promise<StatefulSet>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): StatefulSet[]
items StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_28","title":"Returns","text":"StatefulSet[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | StatefulSet[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_29","title":"Returns","text":"Promise<undefined | StatefulSet[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item StatefulSet request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_31","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_32","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#select","title":"select","text":"\u25b8 select(item): void
item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_37","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): StatefulSet[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? StatefulSet[] the items to be sorted (default: the current items in this store) sorting? (item: StatefulSet) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_38","title":"Returns","text":"StatefulSet[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_39","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? StatefulSet[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_41","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item StatefulSet"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_42","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<StatefulSet>
item StatefulSet data PartialObjectDeep<StatefulSet, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_43","title":"Returns","text":"Promise<StatefulSet>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<StatefulSet>
item StatefulSet request () => Promise<StatefulSet>"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#returns_45","title":"Returns","text":"Promise<StatefulSet>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/","title":"Renderer.K8sApi.StorageClassStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / StorageClassStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#class-storageclassstore","title":"Class: StorageClassStore","text":"Renderer.K8sApi.StorageClassStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<StorageClass, StorageClassApi, StorageClassData>\u21b3 StorageClassStore
\u2022 new StorageClassStore(dependencies, api, opts?)
dependencies StorageClassStoreDependencies api StorageClassApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#overrides","title":"Overrides","text":"KubeObjectStore<StorageClass, StorageClassApi, StorageClassData\\>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#api","title":"api","text":"\u2022 Readonly api: StorageClassApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: StorageClass) => string
\u25b8 (item): string
item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: StorageClassStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<StorageClassData>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#items","title":"items","text":"\u2022 items: IObservableArray<StorageClass>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<StorageClass, void, undefined>
Generator<StorageClass, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<StorageClass>
params Object params.name string params.namespace? string data? PartialObjectDeep<StorageClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_6","title":"Returns","text":"Promise<StorageClass>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | StorageClass>
params Object params.name string params.namespace? string data? PartialObjectDeep<StorageClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_7","title":"Returns","text":"Promise<null | StorageClass>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): StorageClass[]
items StorageClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_8","title":"Returns","text":"StorageClass[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): StorageClass[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_9","title":"Returns","text":"StorageClass[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | StorageClass
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_10","title":"Returns","text":"undefined | StorageClass
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): StorageClass[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_11","title":"Returns","text":"StorageClass[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | StorageClass
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_12","title":"Returns","text":"undefined | StorageClass
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | StorageClass
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_13","title":"Returns","text":"undefined | StorageClass
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getitems","title":"getItems","text":"\u25b8 getItems(): StorageClass[]
StorageClass[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getpersistentvolumes","title":"getPersistentVolumes","text":"\u25b8 getPersistentVolumes(storageClass): PersistentVolume[]
storageClass StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_16","title":"Returns","text":"PersistentVolume[]
\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? StorageClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_19","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#load","title":"load","text":"\u25b8 load(params): Promise<StorageClass>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_20","title":"Returns","text":"Promise<StorageClass>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | StorageClass[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_21","title":"Returns","text":"Promise<undefined | StorageClass[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<StorageClass>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_22","title":"Returns","text":"Promise<StorageClass>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | StorageClass>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_23","title":"Returns","text":"Promise<null | StorageClass>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<StorageClass[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_24","title":"Returns","text":"Promise<StorageClass[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): StorageClass[]
partialItems StorageClass[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_25","title":"Returns","text":"StorageClass[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<StorageClass>
item StorageClass patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_26","title":"Returns","text":"Promise<StorageClass>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): StorageClass[]
items StorageClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_27","title":"Returns","text":"StorageClass[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | StorageClass[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_28","title":"Returns","text":"Promise<undefined | StorageClass[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item StorageClass request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items StorageClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_31","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_34","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#select","title":"select","text":"\u25b8 select(item): void
item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_36","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): StorageClass[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? StorageClass[] the items to be sorted (default: the current items in this store) sorting? (item: StorageClass) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_37","title":"Returns","text":"StorageClass[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_38","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? StorageClass[]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item StorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_41","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<StorageClass>
item StorageClass data PartialObjectDeep<StorageClass, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_42","title":"Returns","text":"Promise<StorageClass>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<StorageClass>
item StorageClass request () => Promise<StorageClass>"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#returns_44","title":"Returns","text":"Promise<StorageClass>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/","title":"Renderer.K8sApi.VerticalPodAutoscalerStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / VerticalPodAutoscalerStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#class-verticalpodautoscalerstore","title":"Class: VerticalPodAutoscalerStore","text":"Renderer.K8sApi.VerticalPodAutoscalerStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<VerticalPodAutoscaler, VerticalPodAutoscalerApi>\u21b3 VerticalPodAutoscalerStore
\u2022 new VerticalPodAutoscalerStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api VerticalPodAutoscalerApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<VerticalPodAutoscaler, VerticalPodAutoscalerApi>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#api","title":"api","text":"\u2022 Readonly api: VerticalPodAutoscalerApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: VerticalPodAutoscaler) => string
\u25b8 (item): string
item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, VerticalPodAutoscalerStatus, VerticalPodAutoscalerSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#items","title":"items","text":"\u2022 items: IObservableArray<VerticalPodAutoscaler>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<VerticalPodAutoscaler, void, undefined>
Generator<VerticalPodAutoscaler, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<VerticalPodAutoscaler>
params Object params.name string params.namespace? string data? PartialObjectDeep<VerticalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_6","title":"Returns","text":"Promise<VerticalPodAutoscaler>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | VerticalPodAutoscaler>
params Object params.name string params.namespace? string data? PartialObjectDeep<VerticalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_7","title":"Returns","text":"Promise<null | VerticalPodAutoscaler>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): VerticalPodAutoscaler[]
items VerticalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_8","title":"Returns","text":"VerticalPodAutoscaler[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): VerticalPodAutoscaler[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_9","title":"Returns","text":"VerticalPodAutoscaler[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | VerticalPodAutoscaler
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_10","title":"Returns","text":"undefined | VerticalPodAutoscaler
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): VerticalPodAutoscaler[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_11","title":"Returns","text":"VerticalPodAutoscaler[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | VerticalPodAutoscaler
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_12","title":"Returns","text":"undefined | VerticalPodAutoscaler
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | VerticalPodAutoscaler
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_13","title":"Returns","text":"undefined | VerticalPodAutoscaler
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getitems","title":"getItems","text":"\u25b8 getItems(): VerticalPodAutoscaler[]
VerticalPodAutoscaler[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? VerticalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#load","title":"load","text":"\u25b8 load(params): Promise<VerticalPodAutoscaler>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_19","title":"Returns","text":"Promise<VerticalPodAutoscaler>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | VerticalPodAutoscaler[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_20","title":"Returns","text":"Promise<undefined | VerticalPodAutoscaler[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<VerticalPodAutoscaler>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_21","title":"Returns","text":"Promise<VerticalPodAutoscaler>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | VerticalPodAutoscaler>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_22","title":"Returns","text":"Promise<null | VerticalPodAutoscaler>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<VerticalPodAutoscaler[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_23","title":"Returns","text":"Promise<VerticalPodAutoscaler[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): VerticalPodAutoscaler[]
partialItems VerticalPodAutoscaler[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_24","title":"Returns","text":"VerticalPodAutoscaler[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<VerticalPodAutoscaler>
item VerticalPodAutoscaler patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_25","title":"Returns","text":"Promise<VerticalPodAutoscaler>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): VerticalPodAutoscaler[]
items VerticalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_26","title":"Returns","text":"VerticalPodAutoscaler[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | VerticalPodAutoscaler[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_27","title":"Returns","text":"Promise<undefined | VerticalPodAutoscaler[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item VerticalPodAutoscaler request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items VerticalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#select","title":"select","text":"\u25b8 select(item): void
item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): VerticalPodAutoscaler[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? VerticalPodAutoscaler[] the items to be sorted (default: the current items in this store) sorting? (item: VerticalPodAutoscaler) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_36","title":"Returns","text":"VerticalPodAutoscaler[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? VerticalPodAutoscaler[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item VerticalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<VerticalPodAutoscaler>
item VerticalPodAutoscaler data PartialObjectDeep<VerticalPodAutoscaler, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_41","title":"Returns","text":"Promise<VerticalPodAutoscaler>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<VerticalPodAutoscaler>
item VerticalPodAutoscaler request () => Promise<VerticalPodAutoscaler>"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#returns_43","title":"Returns","text":"Promise<VerticalPodAutoscaler>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/","title":"Renderer.K8sApi.VolumeClaimStore","text":"@k8slens/extensions / Exports / Renderer / K8sApi / VolumeClaimStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#class-volumeclaimstore","title":"Class: VolumeClaimStore","text":"Renderer.K8sApi.VolumeClaimStore
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#hierarchy","title":"Hierarchy","text":"KubeObjectStore<PersistentVolumeClaim, PersistentVolumeClaimApi>\u21b3 VolumeClaimStore
\u2022 new VolumeClaimStore(dependencies, api, opts?)
dependencies KubeObjectStoreDependencies api PersistentVolumeClaimApi opts? KubeObjectStoreOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#inherited-from","title":"Inherited from","text":"KubeObjectStore<PersistentVolumeClaim, PersistentVolumeClaimApi>.constructor
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#api","title":"api","text":"\u2022 Readonly api: PersistentVolumeClaimApi
KubeObjectStore.api
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#buffersize","title":"bufferSize","text":"\u2022 Readonly bufferSize: number
KubeObjectStore.bufferSize
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#defaultsorting","title":"defaultSorting","text":"\u2022 Protected defaultSorting: (item: PersistentVolumeClaim) => string
\u25b8 (item): string
item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns","title":"Returns","text":"string
KubeObjectStore.defaultSorting
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: KubeObjectStoreDependencies
KubeObjectStore.dependencies
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#eventsbuffer","title":"eventsBuffer","text":"\u2022 Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, PersistentVolumeClaimStatus, PersistentVolumeClaimSpec>>>
KubeObjectStore.eventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#failedloading","title":"failedLoading","text":"\u2022 failedLoading: boolean
KubeObjectStore.failedLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isloaded","title":"isLoaded","text":"\u2022 isLoaded: boolean
KubeObjectStore.isLoaded
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isloading","title":"isLoading","text":"\u2022 isLoading: boolean
KubeObjectStore.isLoading
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#items","title":"items","text":"\u2022 items: IObservableArray<PersistentVolumeClaim>
KubeObjectStore.items
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#limit","title":"limit","text":"\u2022 Readonly limit: undefined | number
KubeObjectStore.limit
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#selecteditemsids","title":"selectedItemsIds","text":"\u2022 selectedItemsIds: ObservableSet<string>
KubeObjectStore.selectedItemsIds
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#accessors_1","title":"Accessors","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#contextitems","title":"contextItems","text":"\u2022 get contextItems(): K[]
K[]
KubeObjectStore.contextItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#query","title":"query","text":"\u2022 get query(): KubeApiQueryParams
KubeApiQueryParams
KubeObjectStore.query
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#selecteditems","title":"selectedItems","text":"\u2022 get selectedItems(): Item[]
Item[]
KubeObjectStore.selectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#iterator","title":"[iterator]","text":"\u25b8 [iterator](): Generator<PersistentVolumeClaim, void, undefined>
Generator<PersistentVolumeClaim, void, undefined>
KubeObjectStore.[iterator]
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#bindwatcheventsupdater","title":"bindWatchEventsUpdater","text":"\u25b8 Protected bindWatchEventsUpdater(delay?): void
delay? number"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_5","title":"Returns","text":"void
KubeObjectStore.bindWatchEventsUpdater
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#create","title":"create","text":"\u25b8 create(params, data?): Promise<PersistentVolumeClaim>
params Object params.name string params.namespace? string data? PartialObjectDeep<PersistentVolumeClaim, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_6","title":"Returns","text":"Promise<PersistentVolumeClaim>
KubeObjectStore.create
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#createitem","title":"createItem","text":"\u25b8 Protected createItem(params, data?): Promise<null | PersistentVolumeClaim>
params Object params.name string params.namespace? string data? PartialObjectDeep<PersistentVolumeClaim, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_7","title":"Returns","text":"Promise<null | PersistentVolumeClaim>
KubeObjectStore.createItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#filteritemsonload","title":"filterItemsOnLoad","text":"\u25b8 Protected filterItemsOnLoad(items): PersistentVolumeClaim[]
items PersistentVolumeClaim[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_8","title":"Returns","text":"PersistentVolumeClaim[]
KubeObjectStore.filterItemsOnLoad
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getallbyns","title":"getAllByNs","text":"\u25b8 getAllByNs(namespace, strict?): PersistentVolumeClaim[]
namespace string | string[] strict? boolean"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_9","title":"Returns","text":"PersistentVolumeClaim[]
KubeObjectStore.getAllByNs
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbyid","title":"getById","text":"\u25b8 getById(id): undefined | PersistentVolumeClaim
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_10","title":"Returns","text":"undefined | PersistentVolumeClaim
KubeObjectStore.getById
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbylabel","title":"getByLabel","text":"\u25b8 getByLabel(labels): PersistentVolumeClaim[]
labels string[] | Partial<Record<string, string>>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_11","title":"Returns","text":"PersistentVolumeClaim[]
KubeObjectStore.getByLabel
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbyname","title":"getByName","text":"\u25b8 getByName(name, namespace?): undefined | PersistentVolumeClaim
name string namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_12","title":"Returns","text":"undefined | PersistentVolumeClaim
KubeObjectStore.getByName
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbypath","title":"getByPath","text":"\u25b8 getByPath(path): undefined | PersistentVolumeClaim
path string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_13","title":"Returns","text":"undefined | PersistentVolumeClaim
KubeObjectStore.getByPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getindexbyid","title":"getIndexById","text":"\u25b8 getIndexById(id): number
id string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_14","title":"Returns","text":"number
KubeObjectStore.getIndexById
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getitems","title":"getItems","text":"\u25b8 getItems(): PersistentVolumeClaim[]
PersistentVolumeClaim[]
KubeObjectStore.getItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#gettotalcount","title":"getTotalCount","text":"\u25b8 getTotalCount(): number
number
KubeObjectStore.getTotalCount
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isselected","title":"isSelected","text":"\u25b8 isSelected(item): boolean
item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_17","title":"Returns","text":"boolean
KubeObjectStore.isSelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isselectedall","title":"isSelectedAll","text":"\u25b8 isSelectedAll(visibleItems?): boolean
visibleItems? PersistentVolumeClaim[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_18","title":"Returns","text":"boolean
KubeObjectStore.isSelectedAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#load","title":"load","text":"\u25b8 load(params): Promise<PersistentVolumeClaim>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_19","title":"Returns","text":"Promise<PersistentVolumeClaim>
KubeObjectStore.load
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loadall","title":"loadAll","text":"\u25b8 loadAll(\u00abdestructured\u00bb?): Promise<undefined | PersistentVolumeClaim[]>
\u00abdestructured\u00bb KubeObjectStoreLoadAllParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_20","title":"Returns","text":"Promise<undefined | PersistentVolumeClaim[]>
KubeObjectStore.loadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loadfrompath","title":"loadFromPath","text":"\u25b8 loadFromPath(resourcePath): Promise<PersistentVolumeClaim>
resourcePath string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_21","title":"Returns","text":"Promise<PersistentVolumeClaim>
KubeObjectStore.loadFromPath
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loaditem","title":"loadItem","text":"\u25b8 Protected loadItem(params): Promise<null | PersistentVolumeClaim>
params Object params.name string params.namespace? string"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_22","title":"Returns","text":"Promise<null | PersistentVolumeClaim>
KubeObjectStore.loadItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loaditems","title":"loadItems","text":"\u25b8 Protected loadItems(\u00abdestructured\u00bb): Promise<PersistentVolumeClaim[]>
\u00abdestructured\u00bb KubeObjectStoreLoadingParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_23","title":"Returns","text":"Promise<PersistentVolumeClaim[]>
KubeObjectStore.loadItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#mergeitems","title":"mergeItems","text":"\u25b8 Protected mergeItems(partialItems, \u00abdestructured\u00bb): PersistentVolumeClaim[]
partialItems PersistentVolumeClaim[] \u00abdestructured\u00bb MergeItemsOptions"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_24","title":"Returns","text":"PersistentVolumeClaim[]
KubeObjectStore.mergeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#patch","title":"patch","text":"\u25b8 patch(item, patch): Promise<PersistentVolumeClaim>
item PersistentVolumeClaim patch Patch"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_25","title":"Returns","text":"Promise<PersistentVolumeClaim>
KubeObjectStore.patch
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#pickonlyselected","title":"pickOnlySelected","text":"\u25b8 pickOnlySelected(items): PersistentVolumeClaim[]
items PersistentVolumeClaim[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_26","title":"Returns","text":"PersistentVolumeClaim[]
KubeObjectStore.pickOnlySelected
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#reloadall","title":"reloadAll","text":"\u25b8 reloadAll(opts?): Promise<undefined | PersistentVolumeClaim[]>
opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_27","title":"Returns","text":"Promise<undefined | PersistentVolumeClaim[]>
KubeObjectStore.reloadAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#remove","title":"remove","text":"\u25b8 remove(item): Promise<void>
item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_28","title":"Returns","text":"Promise<void>
KubeObjectStore.remove
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#removeitem","title":"removeItem","text":"\u25b8 Protected removeItem(item, request): Promise<void>
item PersistentVolumeClaim request () => Promise<any>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_29","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItem
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#removeitems","title":"removeItems","text":"\u25b8 removeItems(items): Promise<void>
items PersistentVolumeClaim[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_30","title":"Returns","text":"Promise<void>
KubeObjectStore.removeItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#removeselecteditems","title":"removeSelectedItems","text":"\u25b8 removeSelectedItems(): Promise<void>
Promise<void>
KubeObjectStore.removeSelectedItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#reset","title":"reset","text":"\u25b8 reset(): void
void
KubeObjectStore.reset
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#resetonerror","title":"resetOnError","text":"\u25b8 Protected resetOnError(error): void
error any"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_33","title":"Returns","text":"void
KubeObjectStore.resetOnError
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#resetselection","title":"resetSelection","text":"\u25b8 resetSelection(): void
void
KubeObjectStore.resetSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#select","title":"select","text":"\u25b8 select(item): void
item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_35","title":"Returns","text":"void
KubeObjectStore.select
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#sortitems","title":"sortItems","text":"\u25b8 Protected sortItems(items?, sorting?, order?): PersistentVolumeClaim[]
Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).
items? PersistentVolumeClaim[] the items to be sorted (default: the current items in this store) sorting? (item: PersistentVolumeClaim) => any[] list of functions to determine sort order (default: sorting by name) order? \"asc\" | \"desc\" whether to sort from least to greatest (\"asc\" (default)) or vice-versa (\"desc\")"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_36","title":"Returns","text":"PersistentVolumeClaim[]
KubeObjectStore.sortItems
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#subscribe","title":"subscribe","text":"\u25b8 subscribe(\u00abdestructured\u00bb?): Disposer
\u00abdestructured\u00bb KubeObjectStoreSubscribeParams"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_37","title":"Returns","text":"Disposer
KubeObjectStore.subscribe
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#toggleselection","title":"toggleSelection","text":"\u25b8 toggleSelection(item): void
item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_38","title":"Returns","text":"void
KubeObjectStore.toggleSelection
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#toggleselectionall","title":"toggleSelectionAll","text":"\u25b8 toggleSelectionAll(visibleItems?): void
visibleItems? PersistentVolumeClaim[]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_39","title":"Returns","text":"void
KubeObjectStore.toggleSelectionAll
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#unselect","title":"unselect","text":"\u25b8 unselect(item): void
item PersistentVolumeClaim"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_40","title":"Returns","text":"void
KubeObjectStore.unselect
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#update","title":"update","text":"\u25b8 update(item, data): Promise<PersistentVolumeClaim>
item PersistentVolumeClaim data PartialObjectDeep<PersistentVolumeClaim, {}>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_41","title":"Returns","text":"Promise<PersistentVolumeClaim>
KubeObjectStore.update
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#updatefromeventsbuffer","title":"updateFromEventsBuffer","text":"\u25b8 Protected updateFromEventsBuffer(): void
void
KubeObjectStore.updateFromEventsBuffer
"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#updateitem","title":"updateItem","text":"\u25b8 Protected updateItem(item, request): Promise<PersistentVolumeClaim>
item PersistentVolumeClaim request () => Promise<PersistentVolumeClaim>"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#returns_43","title":"Returns","text":"Promise<PersistentVolumeClaim>
KubeObjectStore.updateItem
"},{"location":"extensions/api/classes/Renderer.LensExtension/","title":"Renderer.LensExtension","text":"@k8slens/extensions / Exports / Renderer / LensExtension
"},{"location":"extensions/api/classes/Renderer.LensExtension/#class-lensextension","title":"Class: LensExtension","text":"Renderer.LensExtension
"},{"location":"extensions/api/classes/Renderer.LensExtension/#hierarchy","title":"Hierarchy","text":"LensExtension\u21b3 LensExtension
\u2022 new LensExtension(extension)
extension InstalledExtension"},{"location":"extensions/api/classes/Renderer.LensExtension/#overrides","title":"Overrides","text":"LensExtension.constructor
"},{"location":"extensions/api/classes/Renderer.LensExtension/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.LensExtension/#additionalcategorycolumns","title":"additionalCategoryColumns","text":"\u2022 additionalCategoryColumns: AdditionalCategoryColumnRegistration[]
\u2022 appPreferenceTabs: AppPreferenceTabRegistration[]
\u2022 appPreferences: AppPreferenceRegistration[]
\u2022 catalogEntityDetailItems: CatalogEntityDetailRegistration<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>[]
\u2022 clusterFrameComponents: ClusterFrameChildComponent[]
\u2022 clusterPageMenus: ClusterPageMenuRegistration[]
\u2022 clusterPages: PageRegistration[]
\u2022 commands: CommandRegistration[]
\u2022 customCategoryViews: CustomCategoryViewRegistration[]
\u2022 entitySettings: EntitySettingRegistration[]
\u2022 globalPages: PageRegistration[]
\u2022 Readonly id: string
LensExtension.id
"},{"location":"extensions/api/classes/Renderer.LensExtension/#isbundled","title":"isBundled","text":"\u2022 Readonly isBundled: boolean
LensExtension.isBundled
"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjectdetailitems","title":"kubeObjectDetailItems","text":"\u2022 kubeObjectDetailItems: KubeObjectDetailRegistration<KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>>[]
\u2022 kubeObjectHandlers: KubeObjectHandlerRegistration[]
\u2022 kubeObjectMenuItems: KubeObjectMenuRegistration[]
\u2022 kubeObjectStatusTexts: KubeObjectStatusRegistration[]
\u2022 kubeWorkloadsOverviewItems: WorkloadsOverviewDetailRegistration[]
\u2022 Readonly manifest: LensExtensionManifest
LensExtension.manifest
"},{"location":"extensions/api/classes/Renderer.LensExtension/#manifestpath","title":"manifestPath","text":"\u2022 Readonly manifestPath: string
LensExtension.manifestPath
"},{"location":"extensions/api/classes/Renderer.LensExtension/#protocolhandlers","title":"protocolHandlers","text":"\u2022 protocolHandlers: ProtocolHandlerRegistration[]
LensExtension.protocolHandlers
"},{"location":"extensions/api/classes/Renderer.LensExtension/#statusbaritems","title":"statusBarItems","text":"\u2022 statusBarItems: StatusBarRegistration[]
\u2022 topBarItems: TopBarRegistration[]
\u2022 welcomeBanners: WelcomeBannerRegistration[]
\u2022 welcomeMenus: WelcomeMenuRegistration[]
\u2022 get description(): undefined | string
undefined | string
LensExtension.description
"},{"location":"extensions/api/classes/Renderer.LensExtension/#isenabled","title":"isEnabled","text":"\u2022 get isEnabled(): boolean
boolean
LensExtension.isEnabled
"},{"location":"extensions/api/classes/Renderer.LensExtension/#name","title":"name","text":"\u2022 get name(): string
string
LensExtension.name
"},{"location":"extensions/api/classes/Renderer.LensExtension/#sanitizedextensionid","title":"sanitizedExtensionId","text":"\u2022 get sanitizedExtensionId(): string
string
LensExtension.sanitizedExtensionId
"},{"location":"extensions/api/classes/Renderer.LensExtension/#storename","title":"storeName","text":"\u2022 get storeName(): string
string
LensExtension.storeName
"},{"location":"extensions/api/classes/Renderer.LensExtension/#version","title":"version","text":"\u2022 get version(): string
string
LensExtension.version
"},{"location":"extensions/api/classes/Renderer.LensExtension/#methods_1","title":"Methods","text":""},{"location":"extensions/api/classes/Renderer.LensExtension/#activate","title":"activate","text":"\u25b8 activate(): Promise<void>
Promise<void>
LensExtension.activate
"},{"location":"extensions/api/classes/Renderer.LensExtension/#addcatalogcategoryfilter","title":"addCatalogCategoryFilter","text":"\u25b8 addCatalogCategoryFilter(fn): Disposer
Add a filtering function for the catalog categories. This will be removed if the extension is disabled.
"},{"location":"extensions/api/classes/Renderer.LensExtension/#parameters_1","title":"Parameters","text":"Name Type Descriptionfn CategoryFilter The function which should return a truthy value for those categories which should be kept."},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_7","title":"Returns","text":"Disposer
A function to clean up the filter
"},{"location":"extensions/api/classes/Renderer.LensExtension/#addcatalogfilter","title":"addCatalogFilter","text":"\u25b8 addCatalogFilter(fn): Disposer
Add a filtering function for the catalog entities. This will be removed if the extension is disabled.
"},{"location":"extensions/api/classes/Renderer.LensExtension/#parameters_2","title":"Parameters","text":"Name Type Descriptionfn EntityFilter The function which should return a truthy value for those entities which should be kept."},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_8","title":"Returns","text":"Disposer
A function to clean up the filter
"},{"location":"extensions/api/classes/Renderer.LensExtension/#disable","title":"disable","text":"\u25b8 disable(): Promise<void>
Promise<void>
LensExtension.disable
"},{"location":"extensions/api/classes/Renderer.LensExtension/#enable","title":"enable","text":"\u25b8 enable(): Promise<void>
Promise<void>
LensExtension.enable
"},{"location":"extensions/api/classes/Renderer.LensExtension/#getextensionfilefolder","title":"getExtensionFileFolder","text":"\u25b8 getExtensionFileFolder(): Promise<string>
getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension.
Note: there is no security done on this folder, only obfuscation of the folder name.
"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_11","title":"Returns","text":"Promise<string>
LensExtension.getExtensionFileFolder
"},{"location":"extensions/api/classes/Renderer.LensExtension/#isenabledforcluster","title":"isEnabledForCluster","text":"\u25b8 isEnabledForCluster(cluster): Promise<Boolean>
Defines if extension is enabled for a given cluster. This method is only called when the extension is created within a cluster frame.
The default implementation is to return true
Deprecated
Switch to using \"enabled\" or \"visible\" properties in each registration together with activeCluster
cluster KubernetesCluster<KubernetesClusterMetadata, KubernetesClusterStatus, KubernetesClusterSpec>"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_12","title":"Returns","text":"Promise<Boolean>
\u25b8 navigate(pageId?, params?): Promise<void>
pageId? string params? object"},{"location":"extensions/api/classes/Renderer.LensExtension/#returns_13","title":"Returns","text":"Promise<void>
\u25b8 Protected onActivate(): void | Promise<void>
void | Promise<void>
LensExtension.onActivate
"},{"location":"extensions/api/classes/Renderer.LensExtension/#ondeactivate","title":"onDeactivate","text":"\u25b8 Protected onDeactivate(): void | Promise<void>
void | Promise<void>
LensExtension.onDeactivate
"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/","title":"Renderer.Navigation.PageParam","text":"@k8slens/extensions / Exports / Renderer / Navigation / PageParam
"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#class-pageparamvalue","title":"Class: PageParam<Value>","text":"Renderer.Navigation.PageParam
"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#type-parameters","title":"Type parameters","text":"Name TypeValue any"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#constructors","title":"Constructors","text":"\u2022 new PageParam<Value>(dependencies, init)
Value any"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parameters","title":"Parameters","text":"Name Type dependencies PageParamDependencies init PageParamInit<Value>"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#properties_1","title":"Properties","text":""},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#dependencies","title":"dependencies","text":"\u2022 Protected Readonly dependencies: PageParamDependencies
\u2022 Readonly isMulti: boolean
\u2022 Readonly name: string
\u2022 get defaultValue(): undefined | Value
undefined | Value
\u25b8 clear(): void
void
\u25b8 get(): Value
Value
\u25b8 getRaw(): string | string[]
Get stringified raw value(s) from document.location.search
string | string[]
\u25b8 parse(values): Value
values string | string[]"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_4","title":"Returns","text":"Value
\u25b8 set(value, \u00abdestructured\u00bb?): void
value Value \u00abdestructured\u00bb Object \u203a\u00a0mergeGlobals? boolean \u203a\u00a0replaceHistory? boolean"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_5","title":"Returns","text":"void
\u25b8 setRaw(value): void
Set stringified raw value(s) and update document.location.search
value string | string[]"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_6","title":"Returns","text":"void
\u25b8 stringify(value?): string[]
value? Value"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_7","title":"Returns","text":"string[]
\u25b8 toString(\u00abdestructured\u00bb?): string
\u00abdestructured\u00bb Object \u203a\u00a0mergeGlobals? boolean \u203a\u00a0value? Value"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#returns_8","title":"Returns","text":"string
@k8slens/extensions / Exports / Renderer / Component / NotificationStatus
"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#enumeration-notificationstatus","title":"Enumeration: NotificationStatus","text":"Renderer.Component.NotificationStatus
"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#enumeration-members","title":"Enumeration Members","text":"\u2022 ERROR = \"error\"
\u2022 INFO = \"info\"
\u2022 OK = \"ok\"
@k8slens/extensions / Exports / Renderer / Component / TooltipPosition
"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#enumeration-tooltipposition","title":"Enumeration: TooltipPosition","text":"Renderer.Component.TooltipPosition
"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#enumeration-members","title":"Enumeration Members","text":"\u2022 BOTTOM = \"bottom\"
\u2022 BOTTOM_LEFT = \"bottom_left\"
\u2022 BOTTOM_RIGHT = \"bottom_right\"
\u2022 LEFT = \"left\"
\u2022 RIGHT = \"right\"
\u2022 TOP = \"top\"
\u2022 TOP_LEFT = \"top_left\"
\u2022 TOP_RIGHT = \"top_right\"
@k8slens/extensions / Exports / Renderer / K8sApi / KubeObjectStatusLevel
"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#enumeration-kubeobjectstatuslevel","title":"Enumeration: KubeObjectStatusLevel","text":"Renderer.K8sApi.KubeObjectStatusLevel
"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#enumeration-members","title":"Enumeration Members","text":"\u2022 CRITICAL = 3
\u2022 INFO = 1
\u2022 WARNING = 2
@k8slens/extensions / Exports / Common / Catalog / CatalogCategoryEvents
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#interface-catalogcategoryevents","title":"Interface: CatalogCategoryEvents","text":"Common.Catalog.CatalogCategoryEvents
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#properties","title":"Properties","text":"\u2022 catalogAddMenu: (context: CatalogEntityAddMenuContext) => void
\u25b8 (context): void
This event will be emitted when the catalog add menu is opened and is the way to added entries to that menu.
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#parameters","title":"Parameters","text":"Name Typecontext CatalogEntityAddMenuContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#returns","title":"Returns","text":"void
\u2022 contextMenuOpen: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>, context: CatalogEntityContextMenuContext) => void
\u25b8 (entity, context): void
This event will be emitted when the context menu for an entity is declared by this category is opened.
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#parameters_1","title":"Parameters","text":"Name Typeentity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec> context CatalogEntityContextMenuContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#returns_1","title":"Returns","text":"void
\u2022 load: () => void
\u25b8 (): void
This event will be emitted when the category is loaded in the catalog view.
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#returns_2","title":"Returns","text":"void
@k8slens/extensions / Exports / Common / Catalog / CatalogCategoryMetadata
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#interface-catalogcategorymetadata","title":"Interface: CatalogCategoryMetadata","text":"Common.Catalog.CatalogCategoryMetadata
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#properties","title":"Properties","text":"\u2022 Readonly icon: string
Either an <svg> or one of the provided svg names from NamedSvg
\u2022 Readonly name: string
The name of your category. The category can be searched for by this value. This will also be used for the catalog menu.
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/","title":"Common.Catalog.CatalogCategorySpec","text":"@k8slens/extensions / Exports / Common / Catalog / CatalogCategorySpec
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#interface-catalogcategoryspec","title":"Interface: CatalogCategorySpec","text":"Common.Catalog.CatalogCategorySpec
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#properties","title":"Properties","text":"\u2022 Optional Readonly displayColumns: CategoryColumnRegistration[]
These are the columns used for displaying entities when in the catalog.
If this is not provided then some default columns will be used, similar in scope to the columns in the \"Browse\" view.
Even if you provide columns, a \"Name\" column will be provided as well with priority: 0.
These columns will not be used in the \"Browse\" view.
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#group","title":"group","text":"\u2022 Readonly group: string
The grouping for for the category. This MUST be a DNS label.
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#names","title":"names","text":"\u2022 Readonly names: Object
This is the concerning the category
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#type-declaration","title":"Type declaration","text":"Name Type Descriptionkind string The kind of entity that this category is for. This value MUST be a DNS label and MUST be equal to the kind fields that are produced by the .versions.[] \\| .entityClass fields."},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#versions","title":"versions","text":"\u2022 Readonly versions: CatalogCategoryVersion[]
The specific versions of the constructors.
NOTE: the field .apiVersion after construction MUST match {.group}/{.versions.[] | .name}. For example, if group = \"entity.k8slens.dev\" and there is an entry in .versions with name = \"v1alpha1\" then the resulting .apiVersion MUST be entity.k8slens.dev/v1alpha1
@k8slens/extensions / Exports / Common / Catalog / CatalogCategoryVersion
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#interface-catalogcategoryversion","title":"Interface: CatalogCategoryVersion","text":"Common.Catalog.CatalogCategoryVersion
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#properties","title":"Properties","text":"\u2022 Readonly entityClass: CatalogEntityConstructor<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>>
The constructor for the entities.
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#name","title":"name","text":"\u2022 Readonly name: string
The specific version that the associated constructor is for. This MUST be a DNS label and SHOULD be of the form vN, vNalphaY, or vNbetaY where N and Y are both integers greater than 0.
Examples: The following are valid values for this field. - v1 - v1beta1 - v1alpha2 - v3beta2
@k8slens/extensions / Exports / Common / Catalog / CatalogEntityActionContext
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#interface-catalogentityactioncontext","title":"Interface: CatalogEntityActionContext","text":"Common.Catalog.CatalogEntityActionContext
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#properties","title":"Properties","text":"\u2022 navigate: (url: string) => void
\u25b8 (url): void
url string"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#returns","title":"Returns","text":"void
\u2022 setCommandPaletteContext: (context?: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => void
\u25b8 (context?): void
context? CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#returns_1","title":"Returns","text":"void
@k8slens/extensions / Exports / Common / Catalog / CatalogEntityAddMenu
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#interface-catalogentityaddmenu","title":"Interface: CatalogEntityAddMenu","text":"Common.Catalog.CatalogEntityAddMenu
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#hierarchy","title":"Hierarchy","text":"CatalogEntityContextMenu\u21b3 CatalogEntityAddMenu
\u2022 Optional confirm: Object
Confirm click with a message
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#type-declaration","title":"Type declaration","text":"Name Typemessage string"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#inherited-from","title":"Inherited from","text":"CatalogEntityContextMenu.confirm
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#defaultaction","title":"defaultAction","text":"\u2022 Optional defaultAction: boolean
\u2022 icon: string
Menu icon
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#overrides","title":"Overrides","text":"CatalogEntityContextMenu.icon
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#onclick","title":"onClick","text":"\u2022 onClick: () => void | Promise<void>
\u25b8 (): void | Promise<void>
OnClick handler
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#returns","title":"Returns","text":"void | Promise<void>
CatalogEntityContextMenu.onClick
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#title","title":"title","text":"\u2022 title: string
Menu title
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#inherited-from_2","title":"Inherited from","text":"CatalogEntityContextMenu.title
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/","title":"Common.Catalog.CatalogEntityAddMenuContext","text":"@k8slens/extensions / Exports / Common / Catalog / CatalogEntityAddMenuContext
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#interface-catalogentityaddmenucontext","title":"Interface: CatalogEntityAddMenuContext","text":"Common.Catalog.CatalogEntityAddMenuContext
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#properties","title":"Properties","text":"\u2022 menuItems: CatalogEntityAddMenu[]
\u2022 navigate: (url: string) => void
\u25b8 (url): void
url string"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#returns","title":"Returns","text":"void
@k8slens/extensions / Exports / Common / Catalog / CatalogEntityContextMenu
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#interface-catalogentitycontextmenu","title":"Interface: CatalogEntityContextMenu","text":"Common.Catalog.CatalogEntityContextMenu
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#hierarchy","title":"Hierarchy","text":"CatalogEntityContextMenu\u21b3 CatalogEntityAddMenu
\u2022 Optional confirm: Object
Confirm click with a message
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#type-declaration","title":"Type declaration","text":"Name Typemessage string"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#icon","title":"icon","text":"\u2022 Optional icon: string
Menu icon
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#onclick","title":"onClick","text":"\u2022 onClick: () => void | Promise<void>
\u25b8 (): void | Promise<void>
OnClick handler
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#returns","title":"Returns","text":"void | Promise<void>
\u2022 title: string
Menu title
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/","title":"Common.Catalog.CatalogEntityContextMenuContext","text":"@k8slens/extensions / Exports / Common / Catalog / CatalogEntityContextMenuContext
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#interface-catalogentitycontextmenucontext","title":"Interface: CatalogEntityContextMenuContext","text":"Common.Catalog.CatalogEntityContextMenuContext
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#properties","title":"Properties","text":"\u2022 menuItems: CatalogEntityContextMenu[]
\u2022 navigate: CatalogEntityContextMenuNavigate
Navigate to the specified pathname
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/","title":"Common.Catalog.CatalogEntityContextMenuNavigate","text":"@k8slens/extensions / Exports / Common / Catalog / CatalogEntityContextMenuNavigate
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#interface-catalogentitycontextmenunavigate","title":"Interface: CatalogEntityContextMenuNavigate","text":"Common.Catalog.CatalogEntityContextMenuNavigate
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#callable","title":"Callable","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#catalogentitycontextmenunavigate","title":"CatalogEntityContextMenuNavigate","text":"\u25b8 CatalogEntityContextMenuNavigate(pathname, forceMainFrame?): void
pathname string The location to navigate to in the main iframe forceMainFrame? boolean -"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#returns","title":"Returns","text":"void
\u25b8 CatalogEntityContextMenuNavigate(pathname, forceMainFrame): void
pathname string The location to navigate to in the current iframe. Useful for when called within the cluster frame forceMainFrame false -"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#returns_1","title":"Returns","text":"void
@k8slens/extensions / Exports / Common / Catalog / CatalogEntityData
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#interface-catalogentitydatametadata-status-spec","title":"Interface: CatalogEntityData<Metadata, Status, Spec>","text":"Common.Catalog.CatalogEntityData
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends CatalogEntityMetadata = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#properties","title":"Properties","text":"\u2022 metadata: Metadata
\u2022 spec: Spec
\u2022 status: Status
@k8slens/extensions / Exports / Common / Catalog / CatalogEntityKindData
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#interface-catalogentitykinddata","title":"Interface: CatalogEntityKindData","text":"Common.Catalog.CatalogEntityKindData
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#implemented-by","title":"Implemented by","text":"CatalogEntity\u2022 Readonly apiVersion: string
\u2022 Readonly kind: string
@k8slens/extensions / Exports / Common / Catalog / CatalogEntityMetadata
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#interface-catalogentitymetadata","title":"Interface: CatalogEntityMetadata","text":"Common.Catalog.CatalogEntityMetadata
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#hierarchy","title":"Hierarchy","text":"EntityMetadataObject\u21b3 CatalogEntityMetadata
\u21b3\u21b3 KubernetesClusterMetadata
\u2022 Optional description: string
\u2022 labels: Partial<Record<string, string>>
\u2022 name: string
\u2022 Optional shortName: string
\u2022 Optional source: string
\u2022 uid: string
@k8slens/extensions / Exports / Common / Catalog / CatalogEntitySettingsContext
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#interface-catalogentitysettingscontext","title":"Interface: CatalogEntitySettingsContext","text":"Common.Catalog.CatalogEntitySettingsContext
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#properties","title":"Properties","text":"\u2022 menuItems: CatalogEntityContextMenu[]
@k8slens/extensions / Exports / Common / Catalog / CatalogEntitySettingsMenu
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#interface-catalogentitysettingsmenu","title":"Interface: CatalogEntitySettingsMenu","text":"Common.Catalog.CatalogEntitySettingsMenu
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#properties","title":"Properties","text":"\u2022 components: Object
View ComponentType<any>"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#group","title":"group","text":"\u2022 Optional group: string
\u2022 title: string
@k8slens/extensions / Exports / Common / Catalog / CatalogEntityStatus
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#interface-catalogentitystatus","title":"Interface: CatalogEntityStatus","text":"Common.Catalog.CatalogEntityStatus
"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#hierarchy","title":"Hierarchy","text":"CatalogEntityStatus\u21b3 WebLinkStatus
\u21b3 KubernetesClusterStatus
\u2022 Optional active: boolean
\u2022 Optional enabled: boolean
Default
true\n"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#message","title":"message","text":"\u2022 Optional message: string
\u2022 phase: string
\u2022 Optional reason: string
@k8slens/extensions / Exports / Common / Catalog / CategoryColumnRegistration
"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#interface-categorycolumnregistration","title":"Interface: CategoryColumnRegistration","text":"Common.Catalog.CategoryColumnRegistration
"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#hierarchy","title":"Hierarchy","text":"CategoryColumnRegistration\u21b3 AdditionalCategoryColumnRegistration
\u2022 id: string
This value MUST to be unique to your extension
"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#priority","title":"priority","text":"\u2022 Optional priority: number
The sorting order value.
Default
50\n"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#rendercell","title":"renderCell","text":"\u2022 renderCell: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => StrictReactNode
\u25b8 (entity): StrictReactNode
This function will be called to generate the cells (on demand) for the column
"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#parameters","title":"Parameters","text":"Name Typeentity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#returns","title":"Returns","text":"StrictReactNode
\u2022 Optional searchFilter: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | string[]
\u25b8 (entity): string | string[]
If provided then searching is supported on this column and this function will be called to determine if the current search string matches for this row.
"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#parameters_1","title":"Parameters","text":"Name Typeentity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#returns_1","title":"Returns","text":"string | string[]
\u2022 Optional sortCallback: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | number | (string | number)[]
\u25b8 (entity): string | number | (string | number)[]
If provided then the column will support sorting and this function will be called to determine a row's ordering.
strings are sorted ahead of numbers, and arrays determine ordering between equal elements of the previous index.
"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#parameters_2","title":"Parameters","text":"Name Typeentity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#returns_2","title":"Returns","text":"string | number | (string | number)[]
\u2022 titleProps: TitleCellProps
This function will be used to generate the columns title cell.
"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/","title":"Common.Catalog.GeneralEntitySpec","text":"@k8slens/extensions / Exports / Common / Catalog / GeneralEntitySpec
"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#interface-generalentityspec","title":"Interface: GeneralEntitySpec","text":"Common.Catalog.GeneralEntitySpec
"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#hierarchy","title":"Hierarchy","text":"CatalogEntitySpec\u21b3 GeneralEntitySpec
\u2022 Optional icon: Object
background? string material? string"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#path","title":"path","text":"\u2022 path: string
@k8slens/extensions / Exports / Common / Catalog / KubernetesClusterMetadata
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#interface-kubernetesclustermetadata","title":"Interface: KubernetesClusterMetadata","text":"Common.Catalog.KubernetesClusterMetadata
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#hierarchy","title":"Hierarchy","text":"CatalogEntityMetadata\u21b3 KubernetesClusterMetadata
\u2022 Optional description: string
CatalogEntityMetadata.description
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#distro","title":"distro","text":"\u2022 Optional distro: string
\u2022 Optional kubeVersion: string
\u2022 labels: Partial<Record<string, string>>
CatalogEntityMetadata.labels
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#name","title":"name","text":"\u2022 name: string
CatalogEntityMetadata.name
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#shortname","title":"shortName","text":"\u2022 Optional shortName: string
CatalogEntityMetadata.shortName
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#source","title":"source","text":"\u2022 Optional source: string
CatalogEntityMetadata.source
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#uid","title":"uid","text":"\u2022 uid: string
CatalogEntityMetadata.uid
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/","title":"Common.Catalog.KubernetesClusterPrometheusMetrics","text":"@k8slens/extensions / Exports / Common / Catalog / KubernetesClusterPrometheusMetrics
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#interface-kubernetesclusterprometheusmetrics","title":"Interface: KubernetesClusterPrometheusMetrics","text":"Common.Catalog.KubernetesClusterPrometheusMetrics
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#properties","title":"Properties","text":"\u2022 Optional address: Object
namespace string port number prefix string service string"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#type","title":"type","text":"\u2022 Optional type: string
@k8slens/extensions / Exports / Common / Catalog / KubernetesClusterSpec
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#interface-kubernetesclusterspec","title":"Interface: KubernetesClusterSpec","text":"Common.Catalog.KubernetesClusterSpec
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#hierarchy","title":"Hierarchy","text":"CatalogEntitySpec\u21b3 KubernetesClusterSpec
\u2022 Optional accessibleNamespaces: string[]
\u2022 Optional icon: Object
background? string material? string src? string"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#kubeconfigcontext","title":"kubeconfigContext","text":"\u2022 kubeconfigContext: string
\u2022 kubeconfigPath: string
\u2022 Optional metrics: Object
prometheus? KubernetesClusterPrometheusMetrics source string"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/","title":"Common.Catalog.KubernetesClusterStatus","text":"@k8slens/extensions / Exports / Common / Catalog / KubernetesClusterStatus
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#interface-kubernetesclusterstatus","title":"Interface: KubernetesClusterStatus","text":"Common.Catalog.KubernetesClusterStatus
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#hierarchy","title":"Hierarchy","text":"CatalogEntityStatus\u21b3 KubernetesClusterStatus
\u2022 Optional active: boolean
CatalogEntityStatus.active
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#enabled","title":"enabled","text":"\u2022 Optional enabled: boolean
Default
true\n"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#inherited-from_1","title":"Inherited from","text":"CatalogEntityStatus.enabled
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#message","title":"message","text":"\u2022 Optional message: string
CatalogEntityStatus.message
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#phase","title":"phase","text":"\u2022 phase: string
CatalogEntityStatus.phase
"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#reason","title":"reason","text":"\u2022 Optional reason: string
CatalogEntityStatus.reason
"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/","title":"Common.Catalog.TitleCellProps","text":"@k8slens/extensions / Exports / Common / Catalog / TitleCellProps
"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#interface-titlecellprops","title":"Interface: TitleCellProps","text":"Common.Catalog.TitleCellProps
These are the supported props for the title cell
"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#properties","title":"Properties","text":"\u2022 Optional className: string
\u2022 Optional data-testid: string
\u2022 title: string
@k8slens/extensions / Exports / Common / Catalog / WebLinkSpec
"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#interface-weblinkspec","title":"Interface: WebLinkSpec","text":"Common.Catalog.WebLinkSpec
"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#properties","title":"Properties","text":"\u2022 url: string
@k8slens/extensions / Exports / Common / Catalog / WebLinkStatus
"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#interface-weblinkstatus","title":"Interface: WebLinkStatus","text":"Common.Catalog.WebLinkStatus
"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#hierarchy","title":"Hierarchy","text":"CatalogEntityStatus\u21b3 WebLinkStatus
\u2022 Optional active: boolean
CatalogEntityStatus.active
"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#enabled","title":"enabled","text":"\u2022 Optional enabled: boolean
Default
true\n"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#inherited-from_1","title":"Inherited from","text":"CatalogEntityStatus.enabled
"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#message","title":"message","text":"\u2022 Optional message: string
CatalogEntityStatus.message
"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#phase","title":"phase","text":"\u2022 phase: WebLinkStatusPhase
CatalogEntityStatus.phase
"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#reason","title":"reason","text":"\u2022 Optional reason: string
CatalogEntityStatus.reason
"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/","title":"Common.EventBus.AppEvent","text":"@k8slens/extensions / Exports / Common / EventBus / AppEvent
"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#interface-appevent","title":"Interface: AppEvent","text":"Common.EventBus.AppEvent
Data for telemetry
"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#properties","title":"Properties","text":"\u2022 action: string
\u2022 Optional destination: string
\u2022 name: string
\u2022 Optional params: Record<string, any>
@k8slens/extensions / Exports / Common / EventBus / EventEmitterOptions
"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#interface-eventemitteroptions","title":"Interface: EventEmitterOptions","text":"Common.EventBus.EventEmitterOptions
"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#properties","title":"Properties","text":"\u2022 Optional once: boolean
\u2022 Optional prepend: boolean
@k8slens/extensions / Exports / Common / LensExtensionManifest
"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#interface-lensextensionmanifest","title":"Interface: LensExtensionManifest","text":"Common.LensExtensionManifest
"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#hierarchy","title":"Hierarchy","text":"BundledLensExtensionManifest\u21b3 LensExtensionManifest
\u2022 Optional description: string
BundledLensExtensionManifest.description
"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#engines","title":"engines","text":"\u2022 engines: Object
Supported Lens version engine by extension could be defined in manifest.engines.lens Only MAJOR.MINOR version is taken in consideration.
\u25aa [x: string]: string | undefined
lens string"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#main","title":"main","text":"\u2022 Optional main: string
\u2022 name: string
BundledLensExtensionManifest.name
"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#publishconfig","title":"publishConfig","text":"\u2022 Optional publishConfig: Partial<Record<string, string>>
BundledLensExtensionManifest.publishConfig
"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#renderer","title":"renderer","text":"\u2022 Optional renderer: string
\u2022 Optional storeName: string
Specify extension name used for persisting data. Useful if extension is renamed but the data should not be lost.
"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#inherited-from_3","title":"Inherited from","text":"BundledLensExtensionManifest.storeName
"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#version","title":"version","text":"\u2022 version: string
BundledLensExtensionManifest.version
"},{"location":"extensions/api/interfaces/Common.Logger/","title":"Common.Logger","text":"@k8slens/extensions / Exports / Common / Logger
"},{"location":"extensions/api/interfaces/Common.Logger/#interface-logger","title":"Interface: Logger","text":"Common.Logger
"},{"location":"extensions/api/interfaces/Common.Logger/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Logger/#properties","title":"Properties","text":"\u2022 debug: LogFunction
\u2022 error: LogFunction
\u2022 info: LogFunction
\u2022 silly: LogFunction
\u2022 warn: LogFunction
@k8slens/extensions / Exports / Common / Store / ExtensionStoreParams
"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#interface-extensionstoreparamst","title":"Interface: ExtensionStoreParams<T>","text":"Common.Store.ExtensionStoreParams
"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#type-parameters","title":"Type parameters","text":"Name TypeT extends object"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#hierarchy","title":"Hierarchy","text":"Omit<PersistentStorageParams<T>, \"migrations\" | \"cwd\" | \"fromStore\" | \"toJSON\">\u21b3 ExtensionStoreParams
\u2022 Readonly configName: string
Omit.configName
"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#cwd","title":"cwd","text":"\u2022 Optional cwd: string
\u2022 Optional migrations: Migrations<T>
\u2022 Optional Readonly syncOptions: Object
equals? IEqualsComparer<T> fireImmediately? boolean"},{"location":"extensions/api/interfaces/Common.Store.ExtensionStoreParams/#inherited-from_1","title":"Inherited from","text":"Omit.syncOptions
"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/","title":"Common.Store.PersistentStorageParams","text":"@k8slens/extensions / Exports / Common / Store / PersistentStorageParams
"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#interface-persistentstorageparamst","title":"Interface: PersistentStorageParams<T>","text":"Common.Store.PersistentStorageParams
"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#type-parameters","title":"Type parameters","text":"Name TypeT extends object"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#hierarchy","title":"Hierarchy","text":"Omit<Options<T>, \"migrations\">\u21b3 PersistentStorageParams
\u2022 Readonly configName: string
Omit.configName
"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#migrations","title":"migrations","text":"\u2022 Optional Readonly migrations: Partial<Record<string, (store: MigrationStore) => void>>
\u2022 Optional Readonly syncOptions: Object
equals? IEqualsComparer<T> fireImmediately? boolean"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#fromstore","title":"fromStore","text":"\u25b8 fromStore(data): void
fromStore is called internally when a child class syncs with the file system.
Note: This function must be synchronous.
"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#parameters","title":"Parameters","text":"Name Type Descriptiondata Partial<T> the parsed information read from the stored JSON file"},{"location":"extensions/api/interfaces/Common.Store.PersistentStorageParams/#returns","title":"Returns","text":"void
\u25b8 toJSON(): T
toJSON is called when syncing the store to the filesystem. It should produce a JSON serializable object representation of the current state.
It is recommended that a round trip is valid. Namely, calling this.fromStore(this.toJSON()) shouldn't change the state.
T
@k8slens/extensions / Exports / Common / Types / AppPreferenceComponents
"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#interface-apppreferencecomponents","title":"Interface: AppPreferenceComponents","text":"Common.Types.AppPreferenceComponents
"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#properties","title":"Properties","text":"\u2022 Hint: ComponentType<any>
\u2022 Input: ComponentType<any>
@k8slens/extensions / Exports / Common / Types / AppPreferenceRegistration
"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#interface-apppreferenceregistration","title":"Interface: AppPreferenceRegistration","text":"Common.Types.AppPreferenceRegistration
"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#properties","title":"Properties","text":"\u2022 components: AppPreferenceComponents
\u2022 Optional id: string
\u2022 Optional showInPreferencesTab: string
\u2022 title: string
@k8slens/extensions / Exports / Common / Types / ClusterPageMenuComponents
"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#interface-clusterpagemenucomponents","title":"Interface: ClusterPageMenuComponents","text":"Common.Types.ClusterPageMenuComponents
"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#properties","title":"Properties","text":"\u2022 Icon: ComponentType<IconProps>
@k8slens/extensions / Exports / Common / Types / ClusterPageMenuRegistration
"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#interface-clusterpagemenuregistration","title":"Interface: ClusterPageMenuRegistration","text":"Common.Types.ClusterPageMenuRegistration
"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#properties","title":"Properties","text":"\u2022 components: ClusterPageMenuComponents
\u2022 Optional id: string
\u2022 Optional orderNumber: number
\u2022 Optional parentId: string
\u2022 Optional target: PageTarget
\u2022 title: StrictReactNode
\u2022 Optional visible: IComputedValue<boolean>
@k8slens/extensions / Exports / Common / Types / CustomCategoryViewComponents
"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#interface-customcategoryviewcomponents","title":"Interface: CustomCategoryViewComponents","text":"Common.Types.CustomCategoryViewComponents
The components for the category view.
"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#properties","title":"Properties","text":"\u2022 View: ComponentType<CustomCategoryViewProps>
@k8slens/extensions / Exports / Common / Types / CustomCategoryViewProps
"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#interface-customcategoryviewprops","title":"Interface: CustomCategoryViewProps","text":"Common.Types.CustomCategoryViewProps
The props for CustomCategoryViewComponents.View
"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#properties","title":"Properties","text":"\u2022 category: CatalogCategory
The category instance itself
"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/","title":"Common.Types.CustomCategoryViewRegistration","text":"@k8slens/extensions / Exports / Common / Types / CustomCategoryViewRegistration
"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#interface-customcategoryviewregistration","title":"Interface: CustomCategoryViewRegistration","text":"Common.Types.CustomCategoryViewRegistration
This is the type used to declare additional views for a specific category
"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#properties","title":"Properties","text":"\u2022 components: CustomCategoryViewComponents
The components for this registration
"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#group","title":"group","text":"\u2022 group: string
The catalog entity group that is declared by the category for this registration
e.g. - \"entity.k8slens.dev\"
\u2022 kind: string
The catalog entity kind that is declared by the category for this registration
e.g. - \"KubernetesCluster\"
\u2022 Optional priority: number
The sorting order value. Used to determine the total order of the views.
Default
50\n"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/","title":"Common.Types.KubeObjectContextMenuItem","text":"@k8slens/extensions / Exports / Common / Types / KubeObjectContextMenuItem
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#interface-kubeobjectcontextmenuitem","title":"Interface: KubeObjectContextMenuItem","text":"Common.Types.KubeObjectContextMenuItem
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#properties","title":"Properties","text":"\u2022 icon: string | BaseIconProps
If the type is string then it is shorthand for material
This is required because this item can be either rendered as a context menu or as a toolbar in the kube object details page.
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#id","title":"id","text":"\u2022 Optional id: string
\u2022 onClick: (obj: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>) => void
\u25b8 (obj): void
The action when clicked
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#parameters","title":"Parameters","text":"Name Typeobj KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#returns","title":"Returns","text":"void
\u2022 title: string
The title text for the menu item or the hover text for the icon.
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/","title":"Common.Types.KubeObjectDetailComponents","text":"@k8slens/extensions / Exports / Common / Types / KubeObjectDetailComponents
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#interface-kubeobjectdetailcomponentst","title":"Interface: KubeObjectDetailComponents<T>","text":"Common.Types.KubeObjectDetailComponents
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#type-parameters","title":"Type parameters","text":"Name TypeT extends KubeObject = KubeObject"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#properties","title":"Properties","text":"\u2022 Details: ComponentType<KubeObjectDetailsProps<T>>
@k8slens/extensions / Exports / Common / Types / KubeObjectDetailRegistration
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#interface-kubeobjectdetailregistrationt","title":"Interface: KubeObjectDetailRegistration<T>","text":"Common.Types.KubeObjectDetailRegistration
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#type-parameters","title":"Type parameters","text":"Name TypeT extends KubeObject = KubeObject"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#properties","title":"Properties","text":"\u2022 apiVersions: string[]
\u2022 components: KubeObjectDetailComponents<T>
\u2022 kind: string
\u2022 Optional priority: number
\u2022 Optional visible: IComputedValue<boolean>
@k8slens/extensions / Exports / Common / Types / KubeObjectHandlers
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#interface-kubeobjecthandlers","title":"Interface: KubeObjectHandlers","text":"Common.Types.KubeObjectHandlers
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#properties","title":"Properties","text":"\u2022 onContextMenuOpen: KubeObjectOnContextMenuOpen
@k8slens/extensions / Exports / Common / Types / KubeObjectMenuComponents
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#interface-kubeobjectmenucomponents","title":"Interface: KubeObjectMenuComponents","text":"Common.Types.KubeObjectMenuComponents
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#properties","title":"Properties","text":"\u2022 MenuItem: ComponentType<KubeObjectMenuItemProps>
@k8slens/extensions / Exports / Common / Types / KubeObjectMenuRegistration
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#interface-kubeobjectmenuregistration","title":"Interface: KubeObjectMenuRegistration","text":"Common.Types.KubeObjectMenuRegistration
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#properties","title":"Properties","text":"\u2022 apiVersions: string[]
\u2022 components: KubeObjectMenuComponents
\u2022 kind: string
\u2022 Optional visible: IComputedValue<boolean>
@k8slens/extensions / Exports / Common / Types / KubeObjectOnContextMenuOpenContext
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#interface-kubeobjectoncontextmenuopencontext","title":"Interface: KubeObjectOnContextMenuOpenContext","text":"Common.Types.KubeObjectOnContextMenuOpenContext
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#properties","title":"Properties","text":"\u2022 Readonly menuItems: IObservableArray<KubeObjectContextMenuItem>
\u2022 navigate: (location: string) => void
\u25b8 (location): void
location string"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#returns","title":"Returns","text":"void
@k8slens/extensions / Exports / Common / Types / KubeObjectStatusRegistration
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#interface-kubeobjectstatusregistration","title":"Interface: KubeObjectStatusRegistration","text":"Common.Types.KubeObjectStatusRegistration
"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#properties","title":"Properties","text":"\u2022 apiVersions: string[]
\u2022 kind: string
\u2022 resolve: (object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>) => KubeObjectStatus
\u25b8 (object): KubeObjectStatus
object KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#returns","title":"Returns","text":"KubeObjectStatus
\u2022 Optional visible: IComputedValue<boolean>
@k8slens/extensions / Exports / Common / Types / PageComponentProps
"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#interface-pagecomponentpropsp","title":"Interface: PageComponentProps<P>","text":"Common.Types.PageComponentProps
"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#type-parameters","title":"Type parameters","text":"Name TypeP extends PageParams = {}"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#properties","title":"Properties","text":"\u2022 Optional params: { [N in string | number | symbol]: PageParam<P[N]> }
@k8slens/extensions / Exports / Common / Types / PageComponents
"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#interface-pagecomponents","title":"Interface: PageComponents","text":"Common.Types.PageComponents
"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#properties","title":"Properties","text":"\u2022 Page: ComponentType<any>
@k8slens/extensions / Exports / Common / Types / PageParams
"},{"location":"extensions/api/interfaces/Common.Types.PageParams/#interface-pageparamsv","title":"Interface: PageParams<V>","text":"Common.Types.PageParams
"},{"location":"extensions/api/interfaces/Common.Types.PageParams/#type-parameters","title":"Type parameters","text":"Name TypeV any"},{"location":"extensions/api/interfaces/Common.Types.PageParams/#indexable","title":"Indexable","text":"\u25aa [paramName: string]: V
@k8slens/extensions / Exports / Common / Types / PageRegistration
"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#interface-pageregistration","title":"Interface: PageRegistration","text":"Common.Types.PageRegistration
"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#properties","title":"Properties","text":"\u2022 components: PageComponents
\u2022 Optional enabled: IComputedValue<boolean>
\u2022 Optional id: string
Page ID, part of extension's page url, must be unique within same extension When not provided, first registered page without \"id\" would be used for page-menus without target.pageId for same extension
"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#params","title":"params","text":"\u2022 Optional params: PageParams<string | Omit<PageParamInit<any>, \"name\" | \"prefix\">>
@k8slens/extensions / Exports / Common / Types / PageTarget
"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#interface-pagetarget","title":"Interface: PageTarget","text":"Common.Types.PageTarget
"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#properties","title":"Properties","text":"\u2022 Optional extensionId: string
\u2022 Optional pageId: string
\u2022 Optional params: PageParams<any>
@k8slens/extensions / Exports / Common / Types / ProtocolHandlerRegistration
"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#interface-protocolhandlerregistration","title":"Interface: ProtocolHandlerRegistration","text":"Common.Types.ProtocolHandlerRegistration
ProtocolHandlerRegistration is the data required for an extension to register a handler to a specific path or dynamic path.
"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#properties","title":"Properties","text":"\u2022 handler: ProtocolRouteHandler
\u2022 pathSchema: string
@k8slens/extensions / Exports / Common / Types / ProtocolRouteHandler
"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#interface-protocolroutehandler","title":"Interface: ProtocolRouteHandler","text":"Common.Types.ProtocolRouteHandler
"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#callable","title":"Callable","text":""},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#protocolroutehandler","title":"ProtocolRouteHandler","text":"\u25b8 ProtocolRouteHandler(params): void
RouteHandler represents the function signature of the handler function for lens:// protocol routing.
params ProtocolRouteParams"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#returns","title":"Returns","text":"void
@k8slens/extensions / Exports / Common / Types / ProtocolRouteParams
"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#interface-protocolrouteparams","title":"Interface: ProtocolRouteParams","text":"Common.Types.ProtocolRouteParams
The collection of the dynamic parts of a URI which initiated a lens:// protocol request
\u2022 pathname: Record<string, undefined | string>
the matching parts of the path. The dynamic parts of the URI path.
"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#search","title":"search","text":"\u2022 search: Record<string, undefined | string>
the parts of the URI query string
"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#tail","title":"tail","text":"\u2022 Optional tail: string
if the most specific path schema that is matched does not cover the whole of the URI's path. Then this field will be set to the remaining path segments.
Example:
If the path schema /landing/:type is the matched schema for the URI /landing/soft/easy then this field will be set to \"/easy\".
@k8slens/extensions / Exports / Common / Types / RegisteredPage
"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#interface-registeredpage","title":"Interface: RegisteredPage","text":"Common.Types.RegisteredPage
"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#properties","title":"Properties","text":"\u2022 components: PageComponents
\u2022 extensionId: string
\u2022 id: string
\u2022 params: PageParams<PageParam<any>>
\u2022 url: string
@k8slens/extensions / Exports / Common / Types / ShellEnvContext
"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#interface-shellenvcontext","title":"Interface: ShellEnvContext","text":"Common.Types.ShellEnvContext
"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#properties","title":"Properties","text":"\u2022 catalogEntity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>
@k8slens/extensions / Exports / Common / Types / StatusBarRegistration
"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#interface-statusbarregistration","title":"Interface: StatusBarRegistration","text":"Common.Types.StatusBarRegistration
The type for registering status bar items from the LensRendererExtension
"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#properties","title":"Properties","text":"\u2022 Optional components: StatusBarComponents
The newer API, allows for registering a component instead of a StrictReactNode
"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#item","title":"item","text":"\u2022 Optional item: StrictReactNode | () => StrictReactNode
Deprecated
use components instead
"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#visible","title":"visible","text":"\u2022 Optional visible: IComputedValue<boolean>
If specified, controls item visibility
"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/","title":"Common.Types.TrayMenuRegistration","text":"@k8slens/extensions / Exports / Common / Types / TrayMenuRegistration
"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#interface-traymenuregistration","title":"Interface: TrayMenuRegistration","text":"Common.Types.TrayMenuRegistration
"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#properties","title":"Properties","text":"\u2022 Optional click: (menuItem: TrayMenuRegistration) => void
\u25b8 (menuItem): void
menuItem TrayMenuRegistration"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#returns","title":"Returns","text":"void
\u2022 Optional enabled: boolean | IComputedValue<boolean>
\u2022 Optional id: string
\u2022 Optional label: string | IComputedValue<string>
\u2022 Optional submenu: TrayMenuRegistration[]
\u2022 Optional toolTip: string
\u2022 Optional type: \"submenu\" | \"normal\" | \"separator\"
\u2022 Optional visible: IComputedValue<boolean>
@k8slens/extensions / Exports / Common / Util / Disposable
"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#interface-disposable","title":"Interface: Disposable","text":"Common.Util.Disposable
"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Common.Util.Disposable/#methods","title":"Methods","text":"\u25b8 dispose(): void
void
@k8slens/extensions / Exports / Common / Util / Disposer
"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#interface-disposer","title":"Interface: Disposer","text":"Common.Util.Disposer
"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#hierarchy","title":"Hierarchy","text":"Disposer\u21b3 ExtendableDisposer
\u25b8 Disposer(): void
void
@k8slens/extensions / Exports / Common / Util / ExtendableDisposer
"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#interface-extendabledisposer","title":"Interface: ExtendableDisposer","text":"Common.Util.ExtendableDisposer
"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#hierarchy","title":"Hierarchy","text":"Disposer\u21b3 ExtendableDisposer
\u25b8 ExtendableDisposer(): void
void
\u25b8 push(...values): void
...values (Disposer | ExtendableDisposer | Disposable)[]"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#returns_1","title":"Returns","text":"void
@k8slens/extensions / Exports / Main / Catalog / CatalogEntityRegistry
"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#interface-catalogentityregistry","title":"Interface: CatalogEntityRegistry","text":"Main.Catalog.CatalogEntityRegistry
"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#methods","title":"Methods","text":"\u25b8 getItemsForApiKind(apiVersion, kind): CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>[]
apiVersion string kind string"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#returns","title":"Returns","text":"CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>[]
\u25b8 getItemsForApiKind<T>(apiVersion, kind): T[]
Deprecated
use a cast instead of a unbounded type parameter
"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#type-parameters","title":"Type parameters","text":"Name TypeT extends CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec, T>"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#parameters_1","title":"Parameters","text":"Name Type apiVersion string kind string"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#returns_1","title":"Returns","text":"T[]
@k8slens/extensions / Exports / Main / K8sApi / BaseKubeJsonApiObjectMetadata
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#interface-basekubejsonapiobjectmetadatanamespaced","title":"Interface: BaseKubeJsonApiObjectMetadata<Namespaced>","text":"Main.K8sApi.BaseKubeJsonApiObjectMetadata
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#type-parameters","title":"Type parameters","text":"Name TypeNamespaced extends KubeObjectScope"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#indexable","title":"Indexable","text":"\u25aa [key: string]: unknown
\u2022 Optional annotations: Partial<Record<string, string>>
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.
More info: http://kubernetes.io/docs/user-guide/annotations
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#clustername","title":"clusterName","text":"\u2022 Optional clusterName: string
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.
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#creationtimestamp","title":"creationTimestamp","text":"\u2022 Optional Readonly creationTimestamp: string
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.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#deletiongraceperiodseconds","title":"deletionGracePeriodSeconds","text":"\u2022 Optional Readonly deletionGracePeriodSeconds: number
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.
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#deletiontimestamp","title":"deletionTimestamp","text":"\u2022 Optional Readonly deletionTimestamp: string
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 deletionTimestamp 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.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#finalizers","title":"finalizers","text":"\u2022 Optional finalizers: string[]
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.
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#generatename","title":"generateName","text":"\u2022 Optional generateName: string
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.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#generation","title":"generation","text":"\u2022 Optional Readonly generation: number
A sequence number representing a specific generation of the desired state. Populated by the system.
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#labels","title":"labels","text":"\u2022 Optional labels: Partial<Record<string, string>>
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.
More info: http://kubernetes.io/docs/user-guide/labels
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#managedfields","title":"managedFields","text":"\u2022 Optional managedFields: unknown[]
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.
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#name","title":"name","text":"\u2022 Readonly name: string
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.
More info: http://kubernetes.io/docs/user-guide/identifiers#names
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#namespace","title":"namespace","text":"\u2022 Optional Readonly namespace: ScopedNamespace<Namespaced>
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
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#ownerreferences","title":"ownerReferences","text":"\u2022 Optional ownerReferences: OwnerReference[]
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.
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#resourceversion","title":"resourceVersion","text":"\u2022 Optional Readonly resourceVersion: string
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.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#selflink","title":"selfLink","text":"\u2022 Optional Readonly selfLink: string
SelfLink is a URL representing this object. Populated by the system.
"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#uid","title":"uid","text":"\u2022 Optional Readonly uid: string
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.
More info: http://kubernetes.io/docs/user-guide/identifiers#uids
"},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/","title":"Main.K8sApi.ExternalKubeApiOptions","text":"@k8slens/extensions / Exports / Main / K8sApi / ExternalKubeApiOptions
"},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/#interface-externalkubeapioptions","title":"Interface: ExternalKubeApiOptions","text":"Main.K8sApi.ExternalKubeApiOptions
"},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.ExternalKubeApiOptions/#properties","title":"Properties","text":"\u2022 Optional autoRegister: boolean
If true then on creation of the KubeApiinstance a call to apiManager.registerApi will be made. This is true by default to maintain backwards compatibility.
Setting this to false might make KubeObject's details drawer stop working.
Default
true\n"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/","title":"Main.K8sApi.IKubeApiCluster","text":"@k8slens/extensions / Exports / Main / K8sApi / IKubeApiCluster
"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#interface-ikubeapicluster","title":"Interface: IKubeApiCluster","text":"Main.K8sApi.IKubeApiCluster
Deprecated
This type is unused
"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#properties","title":"Properties","text":"\u2022 metadata: Object
uid string"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/","title":"Main.K8sApi.ILocalKubeApiConfig","text":"@k8slens/extensions / Exports / Main / K8sApi / ILocalKubeApiConfig
"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#interface-ilocalkubeapiconfig","title":"Interface: ILocalKubeApiConfig","text":"Main.K8sApi.ILocalKubeApiConfig
"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#properties","title":"Properties","text":"\u2022 metadata: Object
uid string"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/","title":"Main.K8sApi.IPodContainer","text":"@k8slens/extensions / Exports / Main / K8sApi / IPodContainer
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#interface-ipodcontainer","title":"Interface: IPodContainer","text":"Main.K8sApi.IPodContainer
A single application container that you want to run within a pod.
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#properties","title":"Properties","text":"\u2022 Optional args: string[]
Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment.
If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".
Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated.
More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#command","title":"command","text":"\u2022 Optional command: string[]
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment.
If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".
Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated.
More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#env","title":"env","text":"\u2022 Optional env: EnvVar[]
List of environment variables to set in the container. Cannot be updated.
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#envfrom","title":"envFrom","text":"\u2022 Optional envFrom: EnvFromSource[]
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting.
When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#image","title":"image","text":"\u2022 Optional image: string
Docker image name.
More info: https://kubernetes.io/docs/concepts/containers/images
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#imagepullpolicy","title":"imagePullPolicy","text":"\u2022 Optional imagePullPolicy: \"Always\" | \"Never\" | \"IfNotPresent\"
Image pull policy. Defaults to \"Always\" if :latest tag is specified, or \"IfNotPresent\" otherwise. Cannot be updated.
More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#lifecycle","title":"lifecycle","text":"\u2022 Optional lifecycle: Lifecycle
\u2022 Optional livenessProbe: Probe
\u2022 name: string
Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#ports","title":"ports","text":"\u2022 Optional ports: ContainerPort[]
List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.
\u2022 Optional readinessProbe: Probe
\u2022 Optional resources: ResourceRequirements
\u2022 Optional securityContext: SecurityContext
\u2022 Optional startupProbe: Probe
\u2022 Optional stdin: boolean
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF.
Default
false\n"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#stdinonce","title":"stdinOnce","text":"\u2022 Optional stdinOnce: boolean
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions.
If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted.
If this flag is false, a container processes that reads from stdin will never receive an EOF.
Default
false\n"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#terminationmessagepath","title":"terminationMessagePath","text":"\u2022 Optional terminationMessagePath: string
Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message.
Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Cannot be updated.
Default
\"/dev/termination-log\"\n"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#terminationmessagepolicy","title":"terminationMessagePolicy","text":"\u2022 Optional terminationMessagePolicy: \"File\" | \"FallbackToLogsOnError\"
Indicate how the termination message should be populated.
File: will use the contents of terminationMessagePath to populate the container status message on both success and failure.
FallbackToLogsOnError: will use the last chunk of container log output if the termination message file is empty and the container exited with an error.
The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Cannot be updated.
Default
\"File\"\n"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#tty","title":"tty","text":"\u2022 Optional tty: boolean
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default
false\n"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#volumedevices","title":"volumeDevices","text":"\u2022 Optional volumeDevices: VolumeDevice[]
volumeDevices is the list of block devices to be used by the container.
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#volumemounts","title":"volumeMounts","text":"\u2022 Optional volumeMounts: VolumeMount[]
Pod volumes to mount into the container's filesystem. Cannot be updated.
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#workingdir","title":"workingDir","text":"\u2022 Optional workingDir: string
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/","title":"Main.K8sApi.IPodContainerStatus","text":"@k8slens/extensions / Exports / Main / K8sApi / IPodContainerStatus
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#interface-ipodcontainerstatus","title":"Interface: IPodContainerStatus","text":"Main.K8sApi.IPodContainerStatus
"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#properties","title":"Properties","text":"\u2022 Optional containerID: string
\u2022 image: string
\u2022 imageID: string
\u2022 Optional lastState: ContainerState
\u2022 name: string
\u2022 ready: boolean
\u2022 restartCount: number
\u2022 Optional started: boolean
\u2022 Optional state: ContainerState
@k8slens/extensions / Exports / Main / K8sApi / IRemoteKubeApiConfig
"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#interface-iremotekubeapiconfig","title":"Interface: IRemoteKubeApiConfig","text":"Main.K8sApi.IRemoteKubeApiConfig
"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#properties","title":"Properties","text":"\u2022 Optional agent: Agent
Custom instance of https.agent to use for the requests
Remarks
the custom agent replaced default agent, options skipTLSVerify, clientCertificateData, clientKeyData and caData are ignored.
"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#cluster","title":"cluster","text":"\u2022 cluster: Object
caData? string server string skipTLSVerify? boolean"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#user","title":"user","text":"\u2022 user: Object
clientCertificateData? string clientKeyData? string token? string | () => Promise<string>"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/","title":"Main.K8sApi.ISecretRef","text":"@k8slens/extensions / Exports / Main / K8sApi / ISecretRef
"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#interface-isecretref","title":"Interface: ISecretRef","text":"Main.K8sApi.ISecretRef
"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#properties","title":"Properties","text":"\u2022 name: string
\u2022 Optional namespace: string
@k8slens/extensions / Exports / Main / K8sApi / IgnoredKubeApiOptions
"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#interface-ignoredkubeapioptions","title":"Interface: IgnoredKubeApiOptions","text":"Main.K8sApi.IgnoredKubeApiOptions
Deprecated
This type is only present for backwards compatible typescript support
"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#properties","title":"Properties","text":"\u2022 Optional apiBase: any
Deprecated
this option is overridden and should not be used
"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#isnamespaces","title":"isNamespaces","text":"\u2022 Optional isNamespaces: any
Deprecated
this option is overridden and should not be used
"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#kind","title":"kind","text":"\u2022 Optional kind: any
Deprecated
this option is overridden and should not be used
"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#objectconstructor","title":"objectConstructor","text":"\u2022 Optional objectConstructor: any
Deprecated
this option is overridden and should not be used
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/","title":"Main.K8sApi.KubeJsonApiData","text":"@k8slens/extensions / Exports / Main / K8sApi / KubeJsonApiData
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#interface-kubejsonapidatametadata-status-spec","title":"Interface: KubeJsonApiData<Metadata, Status, Spec>","text":"Main.K8sApi.KubeJsonApiData
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#type-parameters","title":"Type parameters","text":"Name TypeMetadata extends KubeJsonApiObjectMetadata = KubeJsonApiObjectMetadata Status unknown Spec unknown"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#indexable","title":"Indexable","text":"\u25aa [otherKeys: string]: unknown
\u2022 Readonly apiVersion: string
\u2022 Readonly kind: string
\u2022 metadata: Metadata
\u2022 Optional spec: Spec
\u2022 Optional status: Status
@k8slens/extensions / Exports / Main / K8sApi / KubeObjectStoreLoadAllParams
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#interface-kubeobjectstoreloadallparams","title":"Interface: KubeObjectStoreLoadAllParams","text":"Main.K8sApi.KubeObjectStoreLoadAllParams
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#properties","title":"Properties","text":"\u2022 Optional merge: boolean
\u2022 Optional namespaces: string[]
\u2022 Optional onLoadFailure: OnLoadFailure
A function that is called when listing fails. If set then blocks errors being rejected with
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#reqinit","title":"reqInit","text":"\u2022 Optional reqInit: RequestInit
@k8slens/extensions / Exports / Main / K8sApi / KubeObjectStoreLoadingParams
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#interface-kubeobjectstoreloadingparams","title":"Interface: KubeObjectStoreLoadingParams","text":"Main.K8sApi.KubeObjectStoreLoadingParams
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#properties","title":"Properties","text":"\u2022 namespaces: string[]
\u2022 Optional onLoadFailure: OnLoadFailure
A function that is called when listing fails. If set then blocks errors being rejected with
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#reqinit","title":"reqInit","text":"\u2022 Optional reqInit: RequestInit
@k8slens/extensions / Exports / Main / K8sApi / KubeObjectStoreSubscribeParams
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#interface-kubeobjectstoresubscribeparams","title":"Interface: KubeObjectStoreSubscribeParams","text":"Main.K8sApi.KubeObjectStoreSubscribeParams
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#properties","title":"Properties","text":"\u2022 Optional abortController: AbortController
An optional parent abort controller
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#onloadfailure","title":"onLoadFailure","text":"\u2022 Optional onLoadFailure: OnLoadFailure
A function that is called when listing fails. If set then blocks errors being rejected with
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/","title":"Main.K8sApi.KubeStatusData","text":"@k8slens/extensions / Exports / Main / K8sApi / KubeStatusData
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#interface-kubestatusdata","title":"Interface: KubeStatusData","text":"Main.K8sApi.KubeStatusData
"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#properties","title":"Properties","text":"\u2022 apiVersion: string
\u2022 code: number
\u2022 kind: string
\u2022 Optional message: string
\u2022 Optional reason: string
\u2022 Optional status: string
@k8slens/extensions / Exports / Main / K8sApi / OwnerReference
"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#interface-ownerreference","title":"Interface: OwnerReference","text":"Main.K8sApi.OwnerReference
"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#properties","title":"Properties","text":"\u2022 apiVersion: string
\u2022 Optional blockOwnerDeletion: boolean
\u2022 Optional controller: boolean
\u2022 kind: string
\u2022 name: string
\u2022 uid: string
@k8slens/extensions / Exports / Renderer / Component / AdditionalCategoryColumnRegistration
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#interface-additionalcategorycolumnregistration","title":"Interface: AdditionalCategoryColumnRegistration","text":"Renderer.Component.AdditionalCategoryColumnRegistration
This is the type used to declare new catalog category columns
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#hierarchy","title":"Hierarchy","text":"CategoryColumnRegistration\u21b3 AdditionalCategoryColumnRegistration
\u2022 group: string
The catalog entity group that is declared by the category for this registration
e.g. - \"entity.k8slens.dev\"
\u2022 id: string
This value MUST to be unique to your extension
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#inherited-from","title":"Inherited from","text":"CategoryColumnRegistration.id
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#kind","title":"kind","text":"\u2022 kind: string
The catalog entity kind that is declared by the category for this registration
e.g. - \"KubernetesCluster\"
\u2022 Optional priority: number
The sorting order value.
Default
50\n"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#inherited-from_1","title":"Inherited from","text":"CategoryColumnRegistration.priority
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#rendercell","title":"renderCell","text":"\u2022 renderCell: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => StrictReactNode
\u25b8 (entity): StrictReactNode
This function will be called to generate the cells (on demand) for the column
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#parameters","title":"Parameters","text":"Name Typeentity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#returns","title":"Returns","text":"StrictReactNode
CategoryColumnRegistration.renderCell
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#searchfilter","title":"searchFilter","text":"\u2022 Optional searchFilter: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | string[]
\u25b8 (entity): string | string[]
If provided then searching is supported on this column and this function will be called to determine if the current search string matches for this row.
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#parameters_1","title":"Parameters","text":"Name Typeentity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#returns_1","title":"Returns","text":"string | string[]
CategoryColumnRegistration.searchFilter
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#sortcallback","title":"sortCallback","text":"\u2022 Optional sortCallback: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | number | (string | number)[]
\u25b8 (entity): string | number | (string | number)[]
If provided then the column will support sorting and this function will be called to determine a row's ordering.
strings are sorted ahead of numbers, and arrays determine ordering between equal elements of the previous index.
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#parameters_2","title":"Parameters","text":"Name Typeentity CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#returns_2","title":"Returns","text":"string | number | (string | number)[]
CategoryColumnRegistration.sortCallback
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#titleprops","title":"titleProps","text":"\u2022 titleProps: TitleCellProps
This function will be used to generate the columns title cell.
"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#inherited-from_5","title":"Inherited from","text":"CategoryColumnRegistration.titleProps
"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/","title":"Renderer.Component.BadgeProps","text":"@k8slens/extensions / Exports / Renderer / Component / BadgeProps
"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#interface-badgeprops","title":"Interface: BadgeProps","text":"Renderer.Component.BadgeProps
"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#hierarchy","title":"Hierarchy","text":"HTMLAttributes<HTMLDivElement>\u21b3 BadgeProps
\u2022 Optional children: StrictReactNode
React.HTMLAttributes.children
"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#disabled","title":"disabled","text":"\u2022 Optional disabled: boolean
\u2022 Optional expandable: boolean
\u2022 Optional flat: boolean
\u2022 Optional label: StrictReactNode
\u2022 Optional scrollable: boolean
\u2022 Optional small: boolean
@k8slens/extensions / Exports / Renderer / Component / BarChartProps
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#interface-barchartprops","title":"Interface: BarChartProps","text":"Renderer.Component.BarChartProps
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#hierarchy","title":"Hierarchy","text":"ChartProps\u21b3 BarChartProps
\u2022 Optional className: string
ChartProps.className
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#data","title":"data","text":"\u2022 data: ChartData
ChartProps.data
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#data-testid","title":"data-testid","text":"\u2022 Optional data-testid: string
ChartProps.data-testid
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#height","title":"height","text":"\u2022 Optional height: string | number
ChartProps.height
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#legendcolors","title":"legendColors","text":"\u2022 Optional legendColors: string[]
ChartProps.legendColors
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#legendposition","title":"legendPosition","text":"\u2022 Optional legendPosition: \"bottom\"
ChartProps.legendPosition
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#name","title":"name","text":"\u2022 Optional name: string
\u2022 Optional options: ChartOptions
ChartProps.options
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#plugins","title":"plugins","text":"\u2022 Optional plugins: PluginServiceRegistrationOptions[]
ChartProps.plugins
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#redraw","title":"redraw","text":"\u2022 Optional redraw: boolean
ChartProps.redraw
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#showchart","title":"showChart","text":"\u2022 Optional showChart: boolean
ChartProps.showChart
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#showlegend","title":"showLegend","text":"\u2022 Optional showLegend: boolean
ChartProps.showLegend
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#timelabelstep","title":"timeLabelStep","text":"\u2022 Optional timeLabelStep: number
\u2022 Optional title: string
ChartProps.title
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#type","title":"type","text":"\u2022 Optional type: ChartKind
ChartProps.type
"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#width","title":"width","text":"\u2022 Optional width: string | number
ChartProps.width
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/","title":"Renderer.Component.BaseIconProps","text":"@k8slens/extensions / Exports / Renderer / Component / BaseIconProps
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#interface-baseiconprops","title":"Interface: BaseIconProps","text":"Renderer.Component.BaseIconProps
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#hierarchy","title":"Hierarchy","text":"BaseIconProps\u21b3 IconProps
\u2022 Optional active: boolean
apply active-state styles
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#big","title":"big","text":"\u2022 Optional big: boolean
A pre-defined icon-size
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#data-testid","title":"data-testid","text":"\u2022 Optional data-testid: string
\u2022 Optional disabled: boolean
\u2022 Optional focusable: boolean
Allow focus to the icon to show .active styles. Only applicable if interactive is true.
Default
true\n"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#href","title":"href","text":"\u2022 Optional href: string
render icon as hyperlink
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#interactive","title":"interactive","text":"\u2022 Optional interactive: boolean
indicates that icon is interactive and highlight it on focus/hover
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#link","title":"link","text":"\u2022 Optional link: LocationDescriptor<unknown>
render icon as NavLink from react-router-dom
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#material","title":"material","text":"\u2022 Optional material: string
One of the names from https://material.io/icons/
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#size","title":"size","text":"\u2022 Optional size: string | number
The icon size (css units)
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#small","title":"small","text":"\u2022 Optional small: boolean
A pre-defined icon-size
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#smallest","title":"smallest","text":"\u2022 Optional smallest: boolean
A pre-defined icon-size
"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#sticker","title":"sticker","text":"\u2022 Optional sticker: boolean
\u2022 Optional svg: string
Either an SVG XML or one of NamedSvg
"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/","title":"Renderer.Component.ButtonProps","text":"@k8slens/extensions / Exports / Renderer / Component / ButtonProps
"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#interface-buttonprops","title":"Interface: ButtonProps","text":"Renderer.Component.ButtonProps
"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#hierarchy","title":"Hierarchy","text":"ButtonHTMLAttributes<any>\u21b3 ButtonProps
\u2022 Optional accent: boolean
\u2022 Optional active: boolean
\u2022 Optional big: boolean
\u2022 Optional children: StrictReactNode
ButtonHTMLAttributes.children
"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#hidden","title":"hidden","text":"\u2022 Optional hidden: boolean
ButtonHTMLAttributes.hidden
"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#href","title":"href","text":"\u2022 Optional href: string
\u2022 Optional label: StrictReactNode
\u2022 Optional light: boolean
\u2022 Optional outlined: boolean
\u2022 Optional plain: boolean
\u2022 Optional primary: boolean
\u2022 Optional round: boolean
\u2022 Optional target: \"_blank\"
\u2022 Optional waiting: boolean
@k8slens/extensions / Exports / Renderer / Component / CheckboxProps
"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#interface-checkboxprops","title":"Interface: CheckboxProps","text":"Renderer.Component.CheckboxProps
"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#properties","title":"Properties","text":"\u2022 Optional children: StrictReactNode
\u2022 Optional className: string
\u2022 Optional disabled: boolean
\u2022 Optional inline: boolean
\u2022 Optional label: StrictReactNode
\u2022 Optional value: boolean
\u25b8 Optional onChange(value, evt): void
value boolean evt ChangeEvent<HTMLInputElement>"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#returns","title":"Returns","text":"void
@k8slens/extensions / Exports / Renderer / Component / ConfirmDialogBooleanParams
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#interface-confirmdialogbooleanparams","title":"Interface: ConfirmDialogBooleanParams","text":"Renderer.Component.ConfirmDialogBooleanParams
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#hierarchy","title":"Hierarchy","text":"ConfirmDialogBooleanParams\u21b3 ConfirmDialogParams
\u2022 Optional cancelButtonProps: Partial<ButtonProps>
\u2022 Optional icon: StrictReactNode
\u2022 Optional labelCancel: StrictReactNode
\u2022 Optional labelOk: StrictReactNode
\u2022 message: StrictReactNode
\u2022 Optional okButtonProps: Partial<ButtonProps>
@k8slens/extensions / Exports / Renderer / Component / ConfirmDialogParams
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#interface-confirmdialogparams","title":"Interface: ConfirmDialogParams","text":"Renderer.Component.ConfirmDialogParams
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#hierarchy","title":"Hierarchy","text":"ConfirmDialogBooleanParams\u21b3 ConfirmDialogParams
\u2022 Optional cancel: () => any
\u25b8 (): any
any
\u2022 Optional cancelButtonProps: Partial<ButtonProps>
ConfirmDialogBooleanParams.cancelButtonProps
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#icon","title":"icon","text":"\u2022 Optional icon: StrictReactNode
ConfirmDialogBooleanParams.icon
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#labelcancel","title":"labelCancel","text":"\u2022 Optional labelCancel: StrictReactNode
ConfirmDialogBooleanParams.labelCancel
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#labelok","title":"labelOk","text":"\u2022 Optional labelOk: StrictReactNode
ConfirmDialogBooleanParams.labelOk
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#message","title":"message","text":"\u2022 message: StrictReactNode
ConfirmDialogBooleanParams.message
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#ok","title":"ok","text":"\u2022 Optional ok: () => any
\u25b8 (): any
any
\u2022 Optional okButtonProps: Partial<ButtonProps>
ConfirmDialogBooleanParams.okButtonProps
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/","title":"Renderer.Component.ConfirmDialogProps","text":"@k8slens/extensions / Exports / Renderer / Component / ConfirmDialogProps
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#interface-confirmdialogprops","title":"Interface: ConfirmDialogProps","text":"Renderer.Component.ConfirmDialogProps
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#hierarchy","title":"Hierarchy","text":"Partial<DialogProps>\u21b3 ConfirmDialogProps
\u2022 Optional animated: boolean
Partial.animated
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#children","title":"children","text":"\u2022 Optional children: StrictReactNode
Partial.children
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#classname","title":"className","text":"\u2022 Optional className: string
Partial.className
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#close","title":"close","text":"\u2022 Optional close: () => void
\u25b8 (): void
void
Partial.close
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#data-testid","title":"data-testid","text":"\u2022 Optional data-testid: string
Partial.data-testid
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#isopen","title":"isOpen","text":"\u2022 Optional isOpen: boolean
Partial.isOpen
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#modal","title":"modal","text":"\u2022 Optional modal: boolean
Partial.modal
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#onclose","title":"onClose","text":"\u2022 Optional onClose: () => void
\u25b8 (): void
void
Partial.onClose
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#onopen","title":"onOpen","text":"\u2022 Optional onOpen: () => void
\u25b8 (): void
void
Partial.onOpen
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#open","title":"open","text":"\u2022 Optional open: () => void
\u25b8 (): void
void
Partial.open
"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#pinned","title":"pinned","text":"\u2022 Optional pinned: boolean
Partial.pinned
"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/","title":"Renderer.Component.CreateNotificationOptions","text":"@k8slens/extensions / Exports / Renderer / Component / CreateNotificationOptions
"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#interface-createnotificationoptions","title":"Interface: CreateNotificationOptions","text":"Renderer.Component.CreateNotificationOptions
"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#properties","title":"Properties","text":"\u2022 Optional id: NotificationId
\u2022 Optional timeout: number
\u25b8 Optional onClose(): void
void
@k8slens/extensions / Exports / Renderer / Component / CustomPlaceholderProps
"},{"location":"extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/#interface-customplaceholderprops","title":"Interface: CustomPlaceholderProps","text":"Renderer.Component.CustomPlaceholderProps
"},{"location":"extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/#hierarchy","title":"Hierarchy","text":"PlaceholderProps<NamespaceSelectFilterOption, true>\u21b3 CustomPlaceholderProps
@k8slens/extensions / Exports / Renderer / Component / DialogProps
"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#interface-dialogprops","title":"Interface: DialogProps","text":"Renderer.Component.DialogProps
"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#properties","title":"Properties","text":"\u2022 Optional animated: boolean
\u2022 Optional children: StrictReactNode
\u2022 Optional className: string
\u2022 Optional close: () => void
\u25b8 (): void
void
\u2022 Optional data-testid: string
\u2022 Optional isOpen: boolean
\u2022 Optional modal: boolean
\u2022 Optional onClose: () => void
\u25b8 (): void
void
\u2022 Optional onOpen: () => void
\u25b8 (): void
void
\u2022 Optional open: () => void
\u25b8 (): void
void
\u2022 Optional pinned: boolean
@k8slens/extensions / Exports / Renderer / Component / DrawerItemLabelsProps
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#interface-draweritemlabelsprops","title":"Interface: DrawerItemLabelsProps","text":"Renderer.Component.DrawerItemLabelsProps
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#hierarchy","title":"Hierarchy","text":"DrawerItemProps\u21b3 DrawerItemLabelsProps
\u2022 Optional hidden: boolean
DrawerItemProps.hidden
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#labels","title":"labels","text":"\u2022 labels: string[] | Partial<Record<string, string>>
\u2022 Optional labelsOnly: boolean
DrawerItemProps.labelsOnly
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#name","title":"name","text":"\u2022 name: StrictReactNode
DrawerItemProps.name
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#renderbooleans","title":"renderBooleans","text":"\u2022 Optional renderBooleans: boolean
Deprecated
This prop is no longer used, you should stringify the booleans yourself.
This was only meant to be an internal prop anyway.
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#inherited-from_3","title":"Inherited from","text":"DrawerItemProps.renderBooleans
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#title","title":"title","text":"\u2022 Optional title: string
DrawerItemProps.title
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/","title":"Renderer.Component.DrawerItemProps","text":"@k8slens/extensions / Exports / Renderer / Component / DrawerItemProps
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#interface-draweritemprops","title":"Interface: DrawerItemProps","text":"Renderer.Component.DrawerItemProps
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#hierarchy","title":"Hierarchy","text":"HTMLAttributes<HTMLDivElement>\u21b3 DrawerItemProps
\u21b3\u21b3 DrawerItemLabelsProps
\u2022 Optional hidden: boolean
React.HTMLAttributes.hidden
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#labelsonly","title":"labelsOnly","text":"\u2022 Optional labelsOnly: boolean
\u2022 name: StrictReactNode
\u2022 Optional renderBooleans: boolean
Deprecated
This prop is no longer used, you should stringify the booleans yourself.
This was only meant to be an internal prop anyway.
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#title","title":"title","text":"\u2022 Optional title: string
React.HTMLAttributes.title
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/","title":"Renderer.Component.DrawerParamTogglerProps","text":"@k8slens/extensions / Exports / Renderer / Component / DrawerParamTogglerProps
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#interface-drawerparamtogglerprops","title":"Interface: DrawerParamTogglerProps","text":"Renderer.Component.DrawerParamTogglerProps
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#properties","title":"Properties","text":"\u2022 children: StrictReactNode
\u2022 label: string | number
@k8slens/extensions / Exports / Renderer / Component / DrawerProps
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#interface-drawerprops","title":"Interface: DrawerProps","text":"Renderer.Component.DrawerProps
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#properties","title":"Properties","text":"\u2022 Optional animation: string
\u2022 Optional children: StrictReactNode
\u2022 Optional className: string | object
\u2022 Optional contentClass: string | object
\u2022 Optional data-testid: string
\u2022 Optional onClose: () => void
\u25b8 (): void
void
\u2022 open: boolean
\u2022 Optional position: DrawerPosition
\u2022 Optional size: string
The width or heigh (depending on position) of the Drawer.
If not set then the Drawer will be resizable.
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#testidforclose","title":"testIdForClose","text":"\u2022 Optional testIdForClose: string
\u2022 title: StrictReactNode
\u2022 Optional toolbar: StrictReactNode
\u2022 Optional usePortal: boolean
@k8slens/extensions / Exports / Renderer / Component / DrawerTitleProps
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#interface-drawertitleprops","title":"Interface: DrawerTitleProps","text":"Renderer.Component.DrawerTitleProps
"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#properties","title":"Properties","text":"\u2022 Optional children: StrictReactNode
\u2022 Optional className: string
\u2022 Optional size: \"title\" | \"sub-title\"
Specifies how large this title is
Default
\"title\"\n"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#title","title":"title","text":"\u2022 Optional title: StrictReactNode
Deprecated
Prefer passing the value as children
@k8slens/extensions / Exports / Renderer / Component / IconDataFnArg
"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#interface-icondatafnarg","title":"Interface: IconDataFnArg","text":"Renderer.Component.IconDataFnArg
"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#properties","title":"Properties","text":"\u2022 isDirty: boolean
@k8slens/extensions / Exports / Renderer / Component / IconProps
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#interface-iconprops","title":"Interface: IconProps","text":"Renderer.Component.IconProps
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#hierarchy","title":"Hierarchy","text":"HTMLAttributes<any>
BaseIconProps
\u21b3 IconProps
\u2022 Optional active: boolean
apply active-state styles
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from","title":"Inherited from","text":"BaseIconProps.active
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#big","title":"big","text":"\u2022 Optional big: boolean
A pre-defined icon-size
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_1","title":"Inherited from","text":"BaseIconProps.big
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#children","title":"children","text":"\u2022 Optional children: StrictReactNode
React.HTMLAttributes.children
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#data-testid","title":"data-testid","text":"\u2022 Optional data-testid: string
BaseIconProps.data-testid
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#disabled","title":"disabled","text":"\u2022 Optional disabled: boolean
BaseIconProps.disabled
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#focusable","title":"focusable","text":"\u2022 Optional focusable: boolean
Allow focus to the icon to show .active styles. Only applicable if interactive is true.
Default
true\n"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_4","title":"Inherited from","text":"BaseIconProps.focusable
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#href","title":"href","text":"\u2022 Optional href: string
render icon as hyperlink
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_5","title":"Inherited from","text":"BaseIconProps.href
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#interactive","title":"interactive","text":"\u2022 Optional interactive: boolean
indicates that icon is interactive and highlight it on focus/hover
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_6","title":"Inherited from","text":"BaseIconProps.interactive
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#link","title":"link","text":"\u2022 Optional link: LocationDescriptor<unknown>
render icon as NavLink from react-router-dom
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_7","title":"Inherited from","text":"BaseIconProps.link
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#material","title":"material","text":"\u2022 Optional material: string
One of the names from https://material.io/icons/
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_8","title":"Inherited from","text":"BaseIconProps.material
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#size","title":"size","text":"\u2022 Optional size: string | number
The icon size (css units)
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_9","title":"Inherited from","text":"BaseIconProps.size
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#small","title":"small","text":"\u2022 Optional small: boolean
A pre-defined icon-size
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_10","title":"Inherited from","text":"BaseIconProps.small
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#smallest","title":"smallest","text":"\u2022 Optional smallest: boolean
A pre-defined icon-size
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_11","title":"Inherited from","text":"BaseIconProps.smallest
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#sticker","title":"sticker","text":"\u2022 Optional sticker: boolean
BaseIconProps.sticker
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#svg","title":"svg","text":"\u2022 Optional svg: string
Either an SVG XML or one of NamedSvg
"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#inherited-from_13","title":"Inherited from","text":"BaseIconProps.svg
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/","title":"Renderer.Component.KubeEventDetailsProps","text":"@k8slens/extensions / Exports / Renderer / Component / KubeEventDetailsProps
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#interface-kubeeventdetailsprops","title":"Interface: KubeEventDetailsProps","text":"Renderer.Component.KubeEventDetailsProps
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#properties","title":"Properties","text":"\u2022 object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>
@k8slens/extensions / Exports / Renderer / Component / KubeObjectDetailsProps
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#interface-kubeobjectdetailspropskube","title":"Interface: KubeObjectDetailsProps<Kube>","text":"Renderer.Component.KubeObjectDetailsProps
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#type-parameters","title":"Type parameters","text":"Name TypeKube extends KubeObject = KubeObject"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#properties","title":"Properties","text":"\u2022 Optional className: string
\u2022 object: Kube
@k8slens/extensions / Exports / Renderer / Component / KubeObjectListLayoutProps
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#interface-kubeobjectlistlayoutpropsk-a-d","title":"Interface: KubeObjectListLayoutProps<K, A, D>","text":"Renderer.Component.KubeObjectListLayoutProps
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-parameters","title":"Type parameters","text":"Name TypeK extends KubeObject A extends KubeApi<K, D> D extends KubeJsonApiDataFor<K>"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#hierarchy","title":"Hierarchy","text":"Omit<ItemListLayoutProps<K, false>, \"getItems\" | \"dependentStores\" | \"preloadStores\">\u21b3 KubeObjectListLayoutProps
\u2022 Optional addRemoveButtons: Partial<AddRemoveButtonsProps>
Omit.addRemoveButtons
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#classname","title":"className","text":"\u2022 className: IClassName
Omit.className
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#columns","title":"columns","text":"\u2022 Optional columns: SpecificKubeListLayoutColumn<K>[]
\u2022 Optional copyClassNameFromHeadCells: boolean
Omit.copyClassNameFromHeadCells
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#customizeheader","title":"customizeHeader","text":"\u2022 Optional customizeHeader: HeaderCustomizer | HeaderCustomizer[]
Omit.customizeHeader
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#customizeremovedialog","title":"customizeRemoveDialog","text":"\u2022 Optional customizeRemoveDialog: (selectedItems: K[]) => Partial<ConfirmDialogParams>
\u25b8 (selectedItems): Partial<ConfirmDialogParams>
selectedItems K[]"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns","title":"Returns","text":"Partial<ConfirmDialogParams>
Omit.customizeRemoveDialog
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#customizetablerowprops","title":"customizeTableRowProps","text":"\u2022 Optional customizeTableRowProps: (item: K) => Partial<TableRowProps<K>>
\u25b8 (item): Partial<TableRowProps<K>>
item K"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_1","title":"Returns","text":"Partial<TableRowProps<K>>
Omit.customizeTableRowProps
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#data-testid","title":"data-testid","text":"\u2022 Optional data-testid: string
Omit.data-testid
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#dependentstores","title":"dependentStores","text":"\u2022 Optional dependentStores: SubscribableStore[]
\u2022 Optional detailsItem: K
Omit.detailsItem
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#failedtoloadmessage","title":"failedToLoadMessage","text":"\u2022 Optional failedToLoadMessage: StrictReactNode
Message to display when a store failed to load
Default
\"Failed to load items\"\n"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#inherited-from_8","title":"Inherited from","text":"Omit.failedToLoadMessage
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#filtercallbacks","title":"filterCallbacks","text":"\u2022 Optional filterCallbacks: ItemsFilters<K>
Omit.filterCallbacks
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#filteritems","title":"filterItems","text":"\u2022 Optional filterItems: ItemsFilter<K>[]
Deprecated
Omit.filterItems
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#getitems","title":"getItems","text":"\u2022 Optional getItems: () => K[]
\u25b8 (): K[]
K[]
\u2022 Optional hasDetailsView: boolean
Omit.hasDetailsView
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#headerclassname","title":"headerClassName","text":"\u2022 Optional headerClassName: IClassName
Omit.headerClassName
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#hidefilters","title":"hideFilters","text":"\u2022 Optional hideFilters: boolean
Omit.hideFilters
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#isconfigurable","title":"isConfigurable","text":"\u2022 Optional isConfigurable: boolean
Omit.isConfigurable
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#isready","title":"isReady","text":"\u2022 Optional isReady: boolean
Omit.isReady
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#isselectable","title":"isSelectable","text":"\u2022 Optional isSelectable: boolean
Omit.isSelectable
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#items","title":"items","text":"\u2022 Optional items: K[]
\u2022 Optional onDetails: (item: K) => void
\u25b8 (item): void
item K"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_3","title":"Returns","text":"void
Omit.onDetails
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#renderfooter","title":"renderFooter","text":"\u2022 Optional renderFooter: (parent: NonInjectedItemListLayout<K, false>) => StrictReactNode
\u25b8 (parent): StrictReactNode
parent NonInjectedItemListLayout<K, false>"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_4","title":"Returns","text":"StrictReactNode
Omit.renderFooter
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#renderheadertitle","title":"renderHeaderTitle","text":"\u2022 Optional renderHeaderTitle: RenderHeaderTitle<K, false>
Omit.renderHeaderTitle
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#renderitemmenu","title":"renderItemMenu","text":"\u2022 Optional renderItemMenu: (item: K, store: ItemListStore<K, false>) => StrictReactNode
\u25b8 (item, store): StrictReactNode
item K store ItemListStore<K, false>"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_5","title":"Returns","text":"StrictReactNode
Omit.renderItemMenu
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#rendertablecontents","title":"renderTableContents","text":"\u2022 renderTableContents: (item: K) => (StrictReactNode | TableCellProps)[]
\u25b8 (item): (StrictReactNode | TableCellProps)[]
item K"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#returns_6","title":"Returns","text":"(StrictReactNode | TableCellProps)[]
Omit.renderTableContents
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#rendertableheader","title":"renderTableHeader","text":"\u2022 Optional renderTableHeader: (undefined | null | TableCellProps)[]
Omit.renderTableHeader
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#resourcename","title":"resourceName","text":"\u2022 Optional resourceName: string
Customize resource name for e.g. search input (\"Search ...\"\") If not provided, ResourceNames is used instead with a fallback to resource kind."},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#searchfilters","title":"searchFilters","text":"
\u2022 Optional searchFilters: SearchFilter<K>[]
Omit.searchFilters
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#showheader","title":"showHeader","text":"\u2022 Optional showHeader: boolean
Omit.showHeader
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#sortingcallbacks","title":"sortingCallbacks","text":"\u2022 Optional sortingCallbacks: TableSortCallbacks<K>
Omit.sortingCallbacks
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#spinnertestid","title":"spinnerTestId","text":"\u2022 Optional spinnerTestId: string
Omit.spinnerTestId
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#store","title":"store","text":"\u2022 store: KubeItemListStore<K>
Omit.store
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#subscribestores","title":"subscribeStores","text":"\u2022 Optional subscribeStores: boolean
\u2022 Optional tableId: string
Omit.tableId
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#tableprops","title":"tableProps","text":"\u2022 Optional tableProps: Partial<TableProps<K>>
Omit.tableProps
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#virtual","title":"virtual","text":"\u2022 Optional virtual: boolean
Omit.virtual
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/","title":"Renderer.Component.KubeObjectMenuProps","text":"@k8slens/extensions / Exports / Renderer / Component / KubeObjectMenuProps
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#interface-kubeobjectmenupropstkubeobject","title":"Interface: KubeObjectMenuProps<TKubeObject>","text":"Renderer.Component.KubeObjectMenuProps
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#type-parameters","title":"Type parameters","text":"Name TypeTKubeObject extends KubeObject"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#hierarchy","title":"Hierarchy","text":"MenuActionsProps\u21b3 KubeObjectMenuProps
\u2022 Optional animated: boolean
MenuActionsProps.animated
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#autocloseonselect","title":"autoCloseOnSelect","text":"\u2022 Optional autoCloseOnSelect: boolean
MenuActionsProps.autoCloseOnSelect
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#autofocus","title":"autoFocus","text":"\u2022 Optional autoFocus: boolean
MenuActionsProps.autoFocus
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#children","title":"children","text":"\u2022 Optional children: StrictReactNode
MenuActionsProps.children
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#classname","title":"className","text":"\u2022 Optional className: string
MenuActionsProps.className
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#closeonclickitem","title":"closeOnClickItem","text":"\u2022 Optional closeOnClickItem: boolean
MenuActionsProps.closeOnClickItem
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#closeonclickoutside","title":"closeOnClickOutside","text":"\u2022 Optional closeOnClickOutside: boolean
MenuActionsProps.closeOnClickOutside
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#closeonscroll","title":"closeOnScroll","text":"\u2022 Optional closeOnScroll: boolean
MenuActionsProps.closeOnScroll
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#data-testid","title":"data-testid","text":"\u2022 Optional data-testid: string
MenuActionsProps.data-testid
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#editable","title":"editable","text":"\u2022 Optional editable: boolean
\u2022 Optional htmlFor: string
MenuActionsProps.htmlFor
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#id","title":"id","text":"\u2022 Optional id: string
MenuActionsProps.id
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#isopen","title":"isOpen","text":"\u2022 Optional isOpen: boolean
MenuActionsProps.isOpen
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#object","title":"object","text":"\u2022 object: TKubeObject
\u2022 Optional onOpen: () => void
\u25b8 (): void
void
MenuActionsProps.onOpen
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#position","title":"position","text":"\u2022 Optional position: MenuPosition
MenuActionsProps.position
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#removable","title":"removable","text":"\u2022 Optional removable: boolean
\u2022 Optional removeAction: () => void | Promise<void>
\u25b8 (): void | Promise<void>
Deprecated
Provide your own remove <MenuItem> as part of the children passed to this component
void | Promise<void>
MenuActionsProps.removeAction
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#removeconfirmationmessage","title":"removeConfirmationMessage","text":"\u2022 Optional removeConfirmationMessage: StrictReactNode | () => StrictReactNode
Deprecated
Provide your own remove <MenuItem> as part of the children passed to this component
MenuActionsProps.removeConfirmationMessage
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#toggleevent","title":"toggleEvent","text":"\u2022 Optional toggleEvent: \"click\" | \"contextmenu\"
MenuActionsProps.toggleEvent
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#toolbar","title":"toolbar","text":"\u2022 Optional toolbar: boolean
MenuActionsProps.toolbar
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#triggericon","title":"triggerIcon","text":"\u2022 Optional triggerIcon: StrictReactNode | IconProps & TooltipDecoratorProps
MenuActionsProps.triggerIcon
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#updateaction","title":"updateAction","text":"\u2022 Optional updateAction: () => void | Promise<void>
\u25b8 (): void | Promise<void>
Deprecated
Provide your own update <MenuItem> as part of the children passed to this component
void | Promise<void>
MenuActionsProps.updateAction
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#useportal","title":"usePortal","text":"\u2022 Optional usePortal: boolean | HTMLElement
MenuActionsProps.usePortal
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#close","title":"close","text":"\u25b8 Optional close(): void
void
MenuActionsProps.close
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#open","title":"open","text":"\u25b8 Optional open(): void
void
MenuActionsProps.open
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/","title":"Renderer.Component.KubeObjectMetaProps","text":"@k8slens/extensions / Exports / Renderer / Component / KubeObjectMetaProps
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#interface-kubeobjectmetaprops","title":"Interface: KubeObjectMetaProps","text":"Renderer.Component.KubeObjectMetaProps
"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#properties","title":"Properties","text":"\u2022 Optional hideFields: keyof BaseKubeJsonApiObjectMetadata<KubeObjectScope>[]
\u2022 object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>
@k8slens/extensions / Exports / Renderer / Component / LineProgressProps
"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#interface-lineprogressprops","title":"Interface: LineProgressProps","text":"Renderer.Component.LineProgressProps
"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#hierarchy","title":"Hierarchy","text":"HTMLProps<HTMLDivElement>\u21b3 LineProgressProps
\u2022 Optional children: StrictReactNode
React.HTMLProps.children
"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#classname","title":"className","text":"\u2022 Optional className: any
React.HTMLProps.className
"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#max","title":"max","text":"\u2022 Optional max: number
React.HTMLProps.max
"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#min","title":"min","text":"\u2022 Optional min: number
React.HTMLProps.min
"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#precise","title":"precise","text":"\u2022 Optional precise: number
\u2022 value: number
React.HTMLProps.value
"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/","title":"Renderer.Component.MainLayoutProps","text":"@k8slens/extensions / Exports / Renderer / Component / MainLayoutProps
"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#interface-mainlayoutprops","title":"Interface: MainLayoutProps","text":"Renderer.Component.MainLayoutProps
"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#properties","title":"Properties","text":"\u2022 Optional children: StrictReactNode
\u2022 Optional className: string
\u2022 Optional footer: StrictReactNode
\u2022 sidebar: StrictReactNode
@k8slens/extensions / Exports / Renderer / Component / MenuActionsProps
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#interface-menuactionsprops","title":"Interface: MenuActionsProps","text":"Renderer.Component.MenuActionsProps
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#hierarchy","title":"Hierarchy","text":"Partial<MenuProps>\u21b3 MenuActionsProps
\u21b3\u21b3 KubeObjectMenuProps
\u2022 Optional animated: boolean
Partial.animated
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#autocloseonselect","title":"autoCloseOnSelect","text":"\u2022 Optional autoCloseOnSelect: boolean
\u2022 Optional autoFocus: boolean
Partial.autoFocus
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#children","title":"children","text":"\u2022 Optional children: StrictReactNode
Partial.children
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#classname","title":"className","text":"\u2022 Optional className: string
Partial.className
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#closeonclickitem","title":"closeOnClickItem","text":"\u2022 Optional closeOnClickItem: boolean
Partial.closeOnClickItem
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#closeonclickoutside","title":"closeOnClickOutside","text":"\u2022 Optional closeOnClickOutside: boolean
Partial.closeOnClickOutside
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#closeonscroll","title":"closeOnScroll","text":"\u2022 Optional closeOnScroll: boolean
Partial.closeOnScroll
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#data-testid","title":"data-testid","text":"\u2022 Optional data-testid: string
Partial.data-testid
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#htmlfor","title":"htmlFor","text":"\u2022 Optional htmlFor: string
Partial.htmlFor
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#id","title":"id","text":"\u2022 Optional id: string
Partial.id
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#isopen","title":"isOpen","text":"\u2022 Optional isOpen: boolean
Partial.isOpen
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#onopen","title":"onOpen","text":"\u2022 Optional onOpen: () => void
\u25b8 (): void
void
\u2022 Optional position: MenuPosition
Partial.position
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#removeaction","title":"removeAction","text":"\u2022 Optional removeAction: () => void | Promise<void>
\u25b8 (): void | Promise<void>
Deprecated
Provide your own remove <MenuItem> as part of the children passed to this component
void | Promise<void>
\u2022 Optional removeConfirmationMessage: StrictReactNode | () => StrictReactNode
Deprecated
Provide your own remove <MenuItem> as part of the children passed to this component
\u2022 Optional toggleEvent: \"click\" | \"contextmenu\"
Partial.toggleEvent
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#toolbar","title":"toolbar","text":"\u2022 Optional toolbar: boolean
\u2022 Optional triggerIcon: StrictReactNode | IconProps & TooltipDecoratorProps
\u2022 Optional updateAction: () => void | Promise<void>
\u25b8 (): void | Promise<void>
Deprecated
Provide your own update <MenuItem> as part of the children passed to this component
void | Promise<void>
\u2022 Optional usePortal: boolean | HTMLElement
Partial.usePortal
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#close","title":"close","text":"\u25b8 Optional close(): void
void
Partial.close
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#open","title":"open","text":"\u25b8 Optional open(): void
void
Partial.open
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/","title":"Renderer.Component.MenuContextValue","text":"@k8slens/extensions / Exports / Renderer / Component / MenuContextValue
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#interface-menucontextvalue","title":"Interface: MenuContextValue","text":"Renderer.Component.MenuContextValue
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#properties","title":"Properties","text":"\u2022 close: () => void
\u25b8 (): void
void
\u2022 Readonly props: Readonly<MenuProps>
@k8slens/extensions / Exports / Renderer / Component / MenuItemProps
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#interface-menuitemprops","title":"Interface: MenuItemProps","text":"Renderer.Component.MenuItemProps
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#hierarchy","title":"Hierarchy","text":"HTMLProps<any>\u21b3 MenuItemProps
\u2022 Optional active: boolean
\u2022 Optional disabled: boolean
React.HTMLProps.disabled
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#href","title":"href","text":"\u2022 Optional href: string
React.HTMLProps.href
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#icon","title":"icon","text":"\u2022 Optional icon: string | Partial<IconProps>
\u2022 Optional spacer: boolean
@k8slens/extensions / Exports / Renderer / Component / MenuPosition
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#interface-menuposition","title":"Interface: MenuPosition","text":"Renderer.Component.MenuPosition
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#properties","title":"Properties","text":"\u2022 Optional bottom: boolean
\u2022 Optional left: boolean
\u2022 Optional right: boolean
\u2022 Optional top: boolean
@k8slens/extensions / Exports / Renderer / Component / MenuProps
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#interface-menuprops","title":"Interface: MenuProps","text":"Renderer.Component.MenuProps
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#properties","title":"Properties","text":"\u2022 Optional animated: boolean
\u2022 Optional autoFocus: boolean
\u2022 Optional children: StrictReactNode
\u2022 Optional className: string
\u2022 Optional closeOnClickItem: boolean
\u2022 Optional closeOnClickOutside: boolean
\u2022 Optional closeOnScroll: boolean
\u2022 Optional data-testid: string
\u2022 Optional htmlFor: string
\u2022 Optional id: string
\u2022 Optional isOpen: boolean
\u2022 Optional position: MenuPosition
\u2022 Optional toggleEvent: \"click\" | \"contextmenu\"
\u2022 Optional usePortal: boolean | HTMLElement
\u25b8 close(): void
void
\u25b8 open(): void
void
@k8slens/extensions / Exports / Renderer / Component / MenuStyle
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#interface-menustyle","title":"Interface: MenuStyle","text":"Renderer.Component.MenuStyle
"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#properties","title":"Properties","text":"\u2022 left: string
\u2022 top: string
@k8slens/extensions / Exports / Renderer / Component / MonacoEditorProps
"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#interface-monacoeditorprops","title":"Interface: MonacoEditorProps","text":"Renderer.Component.MonacoEditorProps
"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#properties","title":"Properties","text":"\u2022 Optional autoFocus: boolean
\u2022 Optional className: string
\u2022 Optional id: string
\u2022 Optional innerRef: ForwardedRef<MonacoEditorRef>
\u2022 Optional language: \"yaml\" | \"json\"
\u2022 Optional options: Partial<IStandaloneEditorConstructionOptions>
\u2022 Optional readOnly: boolean
\u2022 Optional setInitialHeight: boolean
\u2022 Optional style: CSSProperties
\u2022 Optional theme: MonacoTheme
\u2022 value: string
\u25b8 Optional onChange(value, evt): void
value string evt IModelContentChangedEvent"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#returns","title":"Returns","text":"void
\u25b8 Optional onDidContentSizeChange(evt): void
evt IContentSizeChangedEvent"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#returns_1","title":"Returns","text":"void
\u25b8 Optional onDidLayoutChange(info): void
info EditorLayoutInfo"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#returns_2","title":"Returns","text":"void
\u25b8 Optional onError(error): void
error unknown"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#returns_3","title":"Returns","text":"void
\u25b8 Optional onModelChange(model, prev?): void
model ITextModel prev? ITextModel"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#returns_4","title":"Returns","text":"void
@k8slens/extensions / Exports / Renderer / Component / NamespaceSelectProps
"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#interface-namespaceselectpropsismulti","title":"Interface: NamespaceSelectProps<IsMulti>","text":"Renderer.Component.NamespaceSelectProps
"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#type-parameters","title":"Type parameters","text":"Name TypeIsMulti extends boolean"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#hierarchy","title":"Hierarchy","text":"Omit<SelectProps<string, { label: string ; value: string }, IsMulti>, \"options\" | \"value\">\u21b3 NamespaceSelectProps
\u2022 Optional autoConvertOptions: boolean
Deprecated
We will always auto convert options if they are of type string
Omit.autoConvertOptions
"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#id","title":"id","text":"\u2022 Optional id: string
Omit.id
"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#iscreatable","title":"isCreatable","text":"\u2022 Optional isCreatable: boolean
Deprecated
This option does nothing
"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#inherited-from_2","title":"Inherited from","text":"Omit.isCreatable
"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#menuclass","title":"menuClass","text":"\u2022 Optional menuClass: string
Omit.menuClass
"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#showicons","title":"showIcons","text":"\u2022 Optional showIcons: boolean
\u2022 Optional sort: NamespaceSelectSort
\u2022 Optional themeName: \"dark\" | \"light\" | \"outlined\" | \"lens\"
Omit.themeName
"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#value","title":"value","text":"\u2022 value: undefined | null | string
@k8slens/extensions / Exports / Renderer / Component / Notification
"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#interface-notification","title":"Interface: Notification","text":"Renderer.Component.Notification
"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#properties","title":"Properties","text":"\u2022 Optional id: NotificationId
\u2022 message: NotificationMessage
\u2022 Optional status: NotificationStatus
\u2022 Optional timeout: number
\u25b8 Optional onClose(): void
void
@k8slens/extensions / Exports / Renderer / Component / PieChartData
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#interface-piechartdata","title":"Interface: PieChartData","text":"Renderer.Component.PieChartData
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#hierarchy","title":"Hierarchy","text":"ChartData\u21b3 PieChartData
\u2022 Optional datasets: PieChartDataSets[]
ChartJS.ChartData.datasets
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/","title":"Renderer.Component.PieChartProps","text":"@k8slens/extensions / Exports / Renderer / Component / PieChartProps
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#interface-piechartprops","title":"Interface: PieChartProps","text":"Renderer.Component.PieChartProps
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#hierarchy","title":"Hierarchy","text":"ChartProps\u21b3 PieChartProps
\u2022 Optional className: string
ChartProps.className
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#data","title":"data","text":"\u2022 data: ChartData
ChartProps.data
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#data-testid","title":"data-testid","text":"\u2022 Optional data-testid: string
ChartProps.data-testid
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#height","title":"height","text":"\u2022 Optional height: string | number
ChartProps.height
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#legendcolors","title":"legendColors","text":"\u2022 Optional legendColors: string[]
ChartProps.legendColors
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#legendposition","title":"legendPosition","text":"\u2022 Optional legendPosition: \"bottom\"
ChartProps.legendPosition
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#options","title":"options","text":"\u2022 Optional options: ChartOptions
ChartProps.options
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#plugins","title":"plugins","text":"\u2022 Optional plugins: PluginServiceRegistrationOptions[]
ChartProps.plugins
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#redraw","title":"redraw","text":"\u2022 Optional redraw: boolean
ChartProps.redraw
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#showchart","title":"showChart","text":"\u2022 Optional showChart: boolean
ChartProps.showChart
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#showlegend","title":"showLegend","text":"\u2022 Optional showLegend: boolean
ChartProps.showLegend
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#title","title":"title","text":"\u2022 Optional title: string
ChartProps.title
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#type","title":"type","text":"\u2022 Optional type: ChartKind
ChartProps.type
"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#width","title":"width","text":"\u2022 Optional width: string | number
ChartProps.width
"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/","title":"Renderer.Component.PodDetailsListProps","text":"@k8slens/extensions / Exports / Renderer / Component / PodDetailsListProps
"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#interface-poddetailslistprops","title":"Interface: PodDetailsListProps","text":"Renderer.Component.PodDetailsListProps
"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#properties","title":"Properties","text":"\u2022 Optional maxCpu: number
\u2022 Optional maxMemory: number
\u2022 owner: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>
\u2022 pods: Pod[]
@k8slens/extensions / Exports / Renderer / Component / RadioGroupProps
"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#interface-radiogrouppropst","title":"Interface: RadioGroupProps<T>","text":"Renderer.Component.RadioGroupProps
"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#type-parameters","title":"Type parameters","text":"NameT"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#properties","title":"Properties","text":"\u2022 Optional asButtons: boolean
\u2022 children: SingleOrMany<ReactElement<RadioProps<T>, string | JSXElementConstructor<any>>>
\u2022 Optional className: string
\u2022 Optional disabled: boolean
\u2022 onChange: (value: T) => void
\u25b8 (value): void
value T"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#returns","title":"Returns","text":"void
\u2022 Optional value: T
@k8slens/extensions / Exports / Renderer / Component / RadioProps
"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#interface-radiopropst","title":"Interface: RadioProps<T>","text":"Renderer.Component.RadioProps
"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#type-parameters","title":"Type parameters","text":"NameT"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#properties","title":"Properties","text":"\u2022 Optional className: string
\u2022 Optional disabled: boolean
\u2022 label: StrictReactNode
\u2022 value: T
@k8slens/extensions / Exports / Renderer / Component / ResourceMetricsProps
"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#interface-resourcemetricspropskeys","title":"Interface: ResourceMetricsProps<Keys>","text":"Renderer.Component.ResourceMetricsProps
"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#type-parameters","title":"Type parameters","text":"Name TypeKeys extends string"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsProps/#properties","title":"Properties","text":"\u2022 children: ReactChild | ReactChild[]
\u2022 Optional className: string
\u2022 metrics: Partial<Record<Keys, MetricData>> | IAsyncComputed<undefined | null | Partial<Record<Keys, MetricData>>>
\u2022 object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>
\u2022 tabs: AtLeastOneMetricTab
@k8slens/extensions / Exports / Renderer / Component / ResourceMetricsValue
"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#interface-resourcemetricsvalue","title":"Interface: ResourceMetricsValue","text":"Renderer.Component.ResourceMetricsValue
"},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.ResourceMetricsValue/#properties","title":"Properties","text":"\u2022 metrics: undefined | null | Partial<Record<string, MetricData>>
\u2022 object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>
\u2022 tab: MetricsTab
@k8slens/extensions / Exports / Renderer / Component / SearchInputProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#interface-searchinputprops","title":"Interface: SearchInputProps","text":"Renderer.Component.SearchInputProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#hierarchy","title":"Hierarchy","text":"InputProps\u21b3 SearchInputProps
\u2022 Optional autoSelectOnFocus: boolean
InputProps.autoSelectOnFocus
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#bindglobalfocushotkey","title":"bindGlobalFocusHotkey","text":"\u2022 Optional bindGlobalFocusHotkey: boolean
\u2022 Optional blurOnEnter: boolean
InputProps.blurOnEnter
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#compact","title":"compact","text":"\u2022 Optional compact: boolean
\u2022 Optional contentRight: StrictReactNode
InputProps.contentRight
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#dirty","title":"dirty","text":"\u2022 Optional dirty: boolean
InputProps.dirty
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#iconleft","title":"iconLeft","text":"\u2022 Optional iconLeft: IconData
InputProps.iconLeft
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#iconright","title":"iconRight","text":"\u2022 Optional iconRight: IconData
InputProps.iconRight
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#maxrows","title":"maxRows","text":"\u2022 Optional maxRows: number
InputProps.maxRows
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#multiline","title":"multiLine","text":"\u2022 Optional multiLine: boolean
InputProps.multiLine
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#showclearicon","title":"showClearIcon","text":"\u2022 Optional showClearIcon: boolean
\u2022 Optional showErrorsAsTooltip: boolean | Omit<TooltipProps, \"targetId\">
InputProps.showErrorsAsTooltip
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#showvalidationline","title":"showValidationLine","text":"\u2022 Optional showValidationLine: boolean
InputProps.showValidationLine
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#theme","title":"theme","text":"\u2022 Optional theme: \"round-black\" | \"round\"
InputProps.theme
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#trim","title":"trim","text":"\u2022 Optional trim: boolean
InputProps.trim
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#validators","title":"validators","text":"\u2022 Optional validators: SingleOrMany<InputValidator<boolean>>
InputProps.validators
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#onchange","title":"onChange","text":"\u25b8 Optional onChange(value, evt): void
value string evt ChangeEvent<InputElement>"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#returns","title":"Returns","text":"void
InputProps.onChange
"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#onclear","title":"onClear","text":"\u25b8 Optional onClear(): void
void
\u25b8 Optional onSubmit(value, evt): void
value string evt KeyboardEvent<InputElement>"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#returns_2","title":"Returns","text":"void
InputProps.onSubmit
"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/","title":"Renderer.Component.SelectOption","text":"@k8slens/extensions / Exports / Renderer / Component / SelectOption
"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#interface-selectoptionvalue","title":"Interface: SelectOption<Value>","text":"Renderer.Component.SelectOption
"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#type-parameters","title":"Type parameters","text":"NameValue"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#properties","title":"Properties","text":"\u2022 Optional id: string
\u2022 Optional isDisabled: boolean
\u2022 Optional isSelected: boolean
\u2022 label: StrictReactNode
\u2022 value: Value
@k8slens/extensions / Exports / Renderer / Component / SelectProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#interface-selectpropsvalue-option-ismulti-group","title":"Interface: SelectProps<Value, Option, IsMulti, Group>","text":"Renderer.Component.SelectProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#type-parameters","title":"Type parameters","text":"Name TypeValue Value Option extends SelectOption<Value> IsMulti extends boolean Group extends GroupBase<Option> = GroupBase<Option>"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#hierarchy","title":"Hierarchy","text":"Omit<ReactSelectProps<Option, IsMulti, Group>, \"value\" | \"options\">\u21b3 SelectProps
\u2022 Optional autoConvertOptions: boolean
Deprecated
We will always auto convert options if they are of type string
\u2022 Optional id: string
Omit.id
"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#iscreatable","title":"isCreatable","text":"\u2022 Optional isCreatable: boolean
Deprecated
This option does nothing
"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#menuclass","title":"menuClass","text":"\u2022 Optional menuClass: string
\u2022 options: OptionsOrGroups<Option, Group> | LegacyAutoConvertedOptions
\u2022 Optional themeName: \"dark\" | \"light\" | \"outlined\" | \"lens\"
\u2022 Optional value: PropsValue<Value>
@k8slens/extensions / Exports / Renderer / Component / SettingLayoutProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#interface-settinglayoutprops","title":"Interface: SettingLayoutProps","text":"Renderer.Component.SettingLayoutProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#hierarchy","title":"Hierarchy","text":"DOMAttributes<any>\u21b3 SettingLayoutProps
\u2022 Optional back: (evt: MouseEvent<Element, MouseEvent> | KeyboardEvent) => void
\u25b8 (evt): void
evt MouseEvent<Element, MouseEvent> | KeyboardEvent"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#returns","title":"Returns","text":"void
\u2022 Optional className: IClassName
\u2022 Optional closeButtonProps: Object
data-testid? string"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#contentclass","title":"contentClass","text":"\u2022 Optional contentClass: IClassName
\u2022 Optional contentGaps: boolean
\u2022 Optional navigation: StrictReactNode
\u2022 Optional provideBackButtonNavigation: boolean
@k8slens/extensions / Exports / Renderer / Component / SliderProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#interface-sliderprops","title":"Interface: SliderProps","text":"Renderer.Component.SliderProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#hierarchy","title":"Hierarchy","text":"Omit<MaterialSliderProps, \"onChange\">\u21b3 SliderProps
\u2022 Optional className: string
Omit.className
"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#methods_1","title":"Methods","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#onchange","title":"onChange","text":"\u25b8 onChange(evt, value): void
evt FormEvent<any> value number"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#returns","title":"Returns","text":"void
@k8slens/extensions / Exports / Renderer / Component / SpinnerProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#interface-spinnerprops","title":"Interface: SpinnerProps","text":"Renderer.Component.SpinnerProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#hierarchy","title":"Hierarchy","text":"HTMLProps<any>\u21b3 SpinnerProps
\u2022 Optional center: boolean
\u2022 Optional singleColor: boolean
@k8slens/extensions / Exports / Renderer / Component / StatusBrickProps
"},{"location":"extensions/api/interfaces/Renderer.Component.StatusBrickProps/#interface-statusbrickprops","title":"Interface: StatusBrickProps","text":"Renderer.Component.StatusBrickProps
"},{"location":"extensions/api/interfaces/Renderer.Component.StatusBrickProps/#hierarchy","title":"Hierarchy","text":"HTMLAttributes<HTMLDivElement>\u21b3 StatusBrickProps
\u2022 Optional children: StrictReactNode
React.HTMLAttributes.children
"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/","title":"Renderer.Component.StepperProps","text":"@k8slens/extensions / Exports / Renderer / Component / StepperProps
"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#interface-stepperprops","title":"Interface: StepperProps","text":"Renderer.Component.StepperProps
"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#hierarchy","title":"Hierarchy","text":"HTMLProps<any>\u21b3 StepperProps
\u2022 step: number
React.HTMLProps.step
"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#steps","title":"steps","text":"\u2022 steps: Step[]
@k8slens/extensions / Exports / Renderer / Component / SubTitleProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#interface-subtitleprops","title":"Interface: SubTitleProps","text":"Renderer.Component.SubTitleProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#properties","title":"Properties","text":"\u2022 Optional children: StrictReactNode
\u2022 Optional className: string
\u2022 Optional compact: boolean
\u2022 Optional id: string
\u2022 title: StrictReactNode
@k8slens/extensions / Exports / Renderer / Component / SwitchProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#interface-switchprops","title":"Interface: SwitchProps","text":"Renderer.Component.SwitchProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#hierarchy","title":"Hierarchy","text":"Omit<HTMLProps<HTMLInputElement>, \"onChange\">\u21b3 SwitchProps
\u2022 Optional onChange: (checked: boolean, event: ChangeEvent<HTMLInputElement>) => void
\u25b8 (checked, event): void
checked boolean event ChangeEvent<HTMLInputElement>"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#returns","title":"Returns","text":"void
@k8slens/extensions / Exports / Renderer / Component / SwitcherProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#interface-switcherprops","title":"Interface: SwitcherProps","text":"Renderer.Component.SwitcherProps
"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#properties","title":"Properties","text":"\u2022 Optional checked: boolean
\u2022 Optional children: StrictReactNode
\u2022 Optional disabled: boolean
\u2022 Optional name: string
\u2022 Optional onChange: (event: ChangeEvent<HTMLInputElement>, checked: boolean) => void
\u25b8 (event, checked): void
event ChangeEvent<HTMLInputElement> checked boolean"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#returns","title":"Returns","text":"void
@k8slens/extensions / Exports / Renderer / Component / TabLayoutProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#interface-tablayoutprops","title":"Interface: TabLayoutProps","text":"Renderer.Component.TabLayoutProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#properties","title":"Properties","text":"\u2022 Optional children: StrictReactNode
\u2022 Optional className: IClassName
\u2022 Optional contentClass: IClassName
\u2022 Optional scrollable: boolean
\u2022 Optional tabs: TabLayoutRoute[]
@k8slens/extensions / Exports / Renderer / Component / TabLayoutRoute
"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#interface-tablayoutroute","title":"Interface: TabLayoutRoute","text":"Renderer.Component.TabLayoutRoute
"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#properties","title":"Properties","text":"\u2022 component: ComponentType<any>
\u2022 Optional default: boolean
\u2022 Optional exact: boolean
\u2022 routePath: string
\u2022 title: StrictReactNode
\u2022 Optional url: string
@k8slens/extensions / Exports / Renderer / Component / TabProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#interface-tabpropsd","title":"Interface: TabProps<D>","text":"Renderer.Component.TabProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#type-parameters","title":"Type parameters","text":"NameD"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#hierarchy","title":"Hierarchy","text":"DOMAttributes<HTMLElement>\u21b3 TabProps
\u2022 Optional active: boolean
\u2022 Optional className: string
\u2022 Optional disabled: boolean
\u2022 Optional icon: StrictReactNode
\u2022 Optional id: string
\u2022 Optional label: StrictReactNode
\u2022 value: D
@k8slens/extensions / Exports / Renderer / Component / TableHeadProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#interface-tableheadprops","title":"Interface: TableHeadProps","text":"Renderer.Component.TableHeadProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#hierarchy","title":"Hierarchy","text":"DOMAttributes<HTMLDivElement>\u21b3 TableHeadProps
\u2022 Optional className: string
\u2022 Optional flat: boolean
\u2022 Optional nowrap: boolean
\u2022 Optional showTopLine: boolean
\u2022 Optional sticky: boolean
@k8slens/extensions / Exports / Renderer / Component / TableProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#interface-tablepropsitem","title":"Interface: TableProps<Item>","text":"Renderer.Component.TableProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#type-parameters","title":"Type parameters","text":"NameItem"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#hierarchy","title":"Hierarchy","text":"DOMAttributes<HTMLDivElement>\u21b3 TableProps
\u2022 Optional autoSize: boolean
Setup auto-sizing for all columns (flex: 1 0)
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#classname","title":"className","text":"\u2022 Optional className: string
Optional addition class names for the root HTML element
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#customrowheights","title":"customRowHeights","text":"\u2022 Optional customRowHeights: (item: Item, lineHeight: number, paddings: number) => number
\u25b8 (item, lineHeight, paddings): number
item Item lineHeight number paddings number"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#returns","title":"Returns","text":"number
\u2022 Optional getTableRow: (uid: string) => undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>
\u25b8 (uid): undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>
uid string"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#returns_1","title":"Returns","text":"undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>
\u2022 Optional items: Item[]
The raw data for the table
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#noitems","title":"noItems","text":"\u2022 Optional noItems: StrictReactNode
This is shown when items is empty
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#onsort","title":"onSort","text":"\u2022 Optional onSort: (params: TableSortParams) => void
\u25b8 (params): void
callback on sort change
Default: global sync with url
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#parameters_2","title":"Parameters","text":"Name Typeparams TableSortParams"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#returns_2","title":"Returns","text":"void
\u2022 Optional renderRow: (item: Item) => undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>
\u25b8 (item): undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>
item Item"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#returns_3","title":"Returns","text":"undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>
\u2022 Optional rowLineHeight: number
Row line height in pixels
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#rowpadding","title":"rowPadding","text":"\u2022 Optional rowPadding: number
Row padding in pixels
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#scrollable","title":"scrollable","text":"\u2022 Optional scrollable: boolean
Use scrollbar if content is bigger than parent's height
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#selectable","title":"selectable","text":"\u2022 Optional selectable: boolean
Highlight rows on hover
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#selecteditemid","title":"selectedItemId","text":"\u2022 Optional selectedItemId: string
Allows to scroll list to selected item
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#sortbydefault","title":"sortByDefault","text":"\u2022 Optional sortByDefault: Partial<TableSortParams>
default sorting params
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#sortsyncwithurl","title":"sortSyncWithUrl","text":"\u2022 Optional sortSyncWithUrl: boolean
sorting state is managed globally from url params
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#sortable","title":"sortable","text":"\u2022 Optional sortable: TableSortCallbacks<Item>
Define sortable callbacks for every column in <TableHead><TableCell sortBy=\"someCol\"></TableCell></TableHead>
Sort Item
argument in the callback is an object, provided in <TableRow sortItem={someColDataItem}></TableRow>
\u2022 Optional storageKey: string
Deprecated
Unused
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#tableid","title":"tableId","text":"\u2022 Optional tableId: string
Used for persisting sort order and visible columns
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#virtual","title":"virtual","text":"\u2022 Optional virtual: boolean
Use virtual list component to render only visible rows. By default uses a auto sizer to fill available height
"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#virtualheight","title":"virtualHeight","text":"\u2022 Optional virtualHeight: number
Only used when virtual is true. Sets the virtual list to be a fixed height. Needed when used in contexts that already have a parent component that is overflow-y: scroll,
@k8slens/extensions / Exports / Renderer / Component / TableRowProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#interface-tablerowpropsitem","title":"Interface: TableRowProps<Item>","text":"Renderer.Component.TableRowProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#type-parameters","title":"Type parameters","text":"NameItem"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#hierarchy","title":"Hierarchy","text":"DOMAttributes<HTMLDivElement>\u21b3 TableRowProps
\u2022 Optional className: string
\u2022 Optional disabled: boolean
\u2022 Optional nowrap: boolean
Should the inner <TableCell> be aligned to one line white-space: nowrap
\u2022 Optional searchItem: Item
data for searching filters in <Table searchable={}></Table>
\u2022 Optional selected: boolean
\u2022 Optional sortItem: Item
data for sorting callback in <Table sortable={}></Table>
\u2022 Optional style: CSSProperties
\u2022 Optional testId: string
@k8slens/extensions / Exports / Renderer / Component / TableSortParams
"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#interface-tablesortparams","title":"Interface: TableSortParams","text":"Renderer.Component.TableSortParams
"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#properties","title":"Properties","text":"\u2022 orderBy: TableOrderBy
\u2022 sortBy: string
@k8slens/extensions / Exports / Renderer / Component / TabsProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#interface-tabspropsd","title":"Interface: TabsProps<D>","text":"Renderer.Component.TabsProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#type-parameters","title":"Type parameters","text":"NameD"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#hierarchy","title":"Hierarchy","text":"TabsContextValue<D>
Omit<DOMAttributes<HTMLElement>, \"onChange\">
\u21b3 TabsProps
\u2022 Optional autoFocus: boolean
TabsContextValue.autoFocus
"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#center","title":"center","text":"\u2022 Optional center: boolean
\u2022 Optional className: string
\u2022 Optional scrollable: boolean
\u2022 Optional value: D
TabsContextValue.value
"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#withborder","title":"withBorder","text":"\u2022 Optional withBorder: boolean
TabsContextValue.withBorder
"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#wrap","title":"wrap","text":"\u2022 Optional wrap: boolean
\u25b8 Optional onChange(value): void
value D"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#returns","title":"Returns","text":"void
TabsContextValue.onChange
"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/","title":"Renderer.Component.TooltipContentFormatters","text":"@k8slens/extensions / Exports / Renderer / Component / TooltipContentFormatters
"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#interface-tooltipcontentformatters","title":"Interface: TooltipContentFormatters","text":"Renderer.Component.TooltipContentFormatters
"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#properties","title":"Properties","text":"\u2022 Optional narrow: boolean
\u2022 Optional nowrap: boolean
\u2022 Optional small: boolean
\u2022 Optional tableView: boolean
\u2022 Optional warning: boolean
@k8slens/extensions / Exports / Renderer / Component / TooltipDecoratorProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#interface-tooltipdecoratorprops","title":"Interface: TooltipDecoratorProps","text":"Renderer.Component.TooltipDecoratorProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#properties","title":"Properties","text":"\u2022 Optional children: StrictReactNode
\u2022 Optional id: string
\u2022 Optional tooltip: StrictReactNode | Omit<TooltipProps, \"targetId\">
\u2022 Optional tooltipOverrideDisabled: boolean
forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is \"disabled\"
"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/","title":"Renderer.Component.TooltipProps","text":"@k8slens/extensions / Exports / Renderer / Component / TooltipProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#interface-tooltipprops","title":"Interface: TooltipProps","text":"Renderer.Component.TooltipProps
"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#properties","title":"Properties","text":"\u2022 Optional children: StrictReactNode
\u2022 Optional className: IClassName
\u2022 Optional data-testid: string
\u2022 Optional formatters: TooltipContentFormatters
\u2022 Optional offset: number
\u2022 Optional preferredPositions: TooltipPosition | TooltipPosition[]
\u2022 Optional style: CSSProperties
\u2022 targetId: string
\u2022 Optional tooltipOnParentHover: boolean
\u2022 Optional usePortal: boolean
\u2022 Optional visible: boolean
@k8slens/extensions / Exports / Renderer / Component / WizardCommonProps
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#interface-wizardcommonpropsd","title":"Interface: WizardCommonProps<D>","text":"Renderer.Component.WizardCommonProps
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#type-parameters","title":"Type parameters","text":"NameD"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#hierarchy","title":"Hierarchy","text":"WizardCommonProps\u21b3 WizardProps
\u21b3 WizardStepProps
\u2022 Optional data: Partial<D>
\u2022 Optional done: () => void
\u25b8 (): void
void
\u2022 Optional hideSteps: boolean
\u2022 Optional reset: () => void
\u25b8 (): void
void
\u2022 Optional save: (data: Partial<D>, callback?: () => void) => void
\u25b8 (data, callback?): void
data Partial<D> callback? () => void"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#returns_2","title":"Returns","text":"void
@k8slens/extensions / Exports / Renderer / Component / WizardLayoutProps
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#interface-wizardlayoutprops","title":"Interface: WizardLayoutProps","text":"Renderer.Component.WizardLayoutProps
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#hierarchy","title":"Hierarchy","text":"DOMAttributes<any>\u21b3 WizardLayoutProps
\u2022 Optional centered: boolean
\u2022 Optional className: IClassName
\u2022 Optional contentClass: IClassName
\u2022 Optional header: StrictReactNode
\u2022 Optional headerClass: IClassName
\u2022 Optional infoPanel: StrictReactNode
\u2022 Optional infoPanelClass: IClassName
@k8slens/extensions / Exports / Renderer / Component / WizardProps
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#interface-wizardpropsd","title":"Interface: WizardProps<D>","text":"Renderer.Component.WizardProps
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#type-parameters","title":"Type parameters","text":"NameD"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#hierarchy","title":"Hierarchy","text":"WizardCommonProps<D>\u21b3 WizardProps
\u2022 Optional children: ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>> | ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>>[]
\u2022 Optional className: string
\u2022 Optional data: Partial<D>
WizardCommonProps.data
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#done","title":"done","text":"\u2022 Optional done: () => void
\u25b8 (): void
void
WizardCommonProps.done
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#header","title":"header","text":"\u2022 Optional header: StrictReactNode
\u2022 Optional hideSteps: boolean
WizardCommonProps.hideSteps
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#onchange","title":"onChange","text":"\u2022 Optional onChange: (step: number) => void
\u25b8 (step): void
step number"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#returns_1","title":"Returns","text":"void
\u2022 Optional reset: () => void
\u25b8 (): void
void
WizardCommonProps.reset
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#save","title":"save","text":"\u2022 Optional save: (data: Partial<D>, callback?: () => void) => void
\u25b8 (data, callback?): void
data Partial<D> callback? () => void"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#returns_3","title":"Returns","text":"void
WizardCommonProps.save
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#step","title":"step","text":"\u2022 Optional step: number
\u2022 Optional title: string
@k8slens/extensions / Exports / Renderer / Component / WizardStepProps
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#interface-wizardsteppropsd","title":"Interface: WizardStepProps<D>","text":"Renderer.Component.WizardStepProps
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-parameters","title":"Type parameters","text":"NameD"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hierarchy","title":"Hierarchy","text":"WizardCommonProps<D>\u21b3 WizardStepProps
\u2022 Optional afterContent: StrictReactNode
\u2022 Optional beforeContent: StrictReactNode
\u2022 Optional children: StrictReactNode | StrictReactNode[]
\u2022 Optional className: string | object
\u2022 Optional contentClass: string | object
\u2022 Optional customButtons: StrictReactNode
\u2022 Optional data: Partial<D>
WizardCommonProps.data
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#disablednext","title":"disabledNext","text":"\u2022 Optional disabledNext: boolean
\u2022 Optional done: () => void
\u25b8 (): void
void
WizardCommonProps.done
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#first","title":"first","text":"\u2022 Optional first: () => void
\u25b8 (): void
void
\u2022 Optional hideBackBtn: boolean
\u2022 Optional hideNextBtn: boolean
\u2022 Optional hideSteps: boolean
WizardCommonProps.hideSteps
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#isfirst","title":"isFirst","text":"\u2022 Optional isFirst: () => boolean
\u25b8 (): boolean
boolean
\u2022 Optional isLast: () => boolean
\u25b8 (): boolean
boolean
\u2022 Optional last: () => void
\u25b8 (): void
void
\u2022 Optional loading: boolean
\u2022 Optional moreButtons: StrictReactNode
\u2022 Optional next: () => boolean | void | Promise<any>
\u25b8 (): boolean | void | Promise<any>
boolean | void | Promise<any>
\u2022 Optional nextLabel: StrictReactNode
\u2022 Optional noValidate: boolean
\u2022 Optional prev: () => void
\u25b8 (): void
void
\u2022 Optional prevLabel: StrictReactNode
\u2022 Optional reset: () => void
\u25b8 (): void
void
WizardCommonProps.reset
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#save","title":"save","text":"\u2022 Optional save: (data: Partial<D>, callback?: () => void) => void
\u25b8 (data, callback?): void
data Partial<D> callback? () => void"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#returns_8","title":"Returns","text":"void
WizardCommonProps.save
"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#scrollable","title":"scrollable","text":"\u2022 Optional scrollable: boolean
\u2022 Optional skip: boolean
\u2022 Optional step: number
\u2022 Optional testIdForNext: string
\u2022 Optional testIdForPrev: string
\u2022 Optional title: string
\u2022 Optional waiting: boolean
\u2022 Optional wizard: Wizard<D>
@k8slens/extensions / Exports / Renderer / K8sApi / KubeObjectStatus
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#interface-kubeobjectstatus","title":"Interface: KubeObjectStatus","text":"Renderer.K8sApi.KubeObjectStatus
Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#properties","title":"Properties","text":"\u2022 level: KubeObjectStatusLevel
\u2022 text: string
\u2022 Optional timestamp: string
@k8slens/extensions / Exports / Renderer / K8sApi / MetricData
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#interface-metricdata","title":"Interface: MetricData","text":"Renderer.K8sApi.MetricData
Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#properties","title":"Properties","text":"\u2022 data: Object
result MetricResult[] resultType string"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#status","title":"status","text":"\u2022 status: string
@k8slens/extensions / Exports / Renderer / K8sApi / MetricResult
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#interface-metricresult","title":"Interface: MetricResult","text":"Renderer.K8sApi.MetricResult
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#properties","title":"Properties","text":"\u2022 metric: Object
\u25aa [name: string]: string | undefined
instance? string kubernetes? string kubernetes_namespace? string kubernetes_node? string node? string pod? string"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#values","title":"values","text":"\u2022 values: [number, string][]
@k8slens/extensions / Exports / Renderer / K8sApi / RequestMetricsParams
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#interface-requestmetricsparams","title":"Interface: RequestMetricsParams","text":"Renderer.K8sApi.RequestMetricsParams
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#properties","title":"Properties","text":"\u2022 Optional end: string | number
timestamp in seconds or valid date-string
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#namespace","title":"namespace","text":"\u2022 Optional namespace: string
rbac-proxy validation param
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#range","title":"range","text":"\u2022 Optional range: number
time-range in seconds for data aggregation
Default
3600 (1 hour)\n"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#start","title":"start","text":"\u2022 Optional start: string | number
timestamp in seconds or valid date-string
"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#step","title":"step","text":"\u2022 Optional step: number
step in seconds
Default
60 (1 minute)\n"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/","title":"Renderer.Navigation.PageParamInit","text":"@k8slens/extensions / Exports / Renderer / Navigation / PageParamInit
"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#interface-pageparaminitvalue","title":"Interface: PageParamInit<Value>","text":"Renderer.Navigation.PageParamInit
"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#type-parameters","title":"Type parameters","text":"Name TypeValue any"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#properties","title":"Properties","text":"\u2022 Optional defaultValue: Value
\u2022 name: string
\u25b8 Optional parse(value): Value
value string | string[]"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#returns","title":"Returns","text":"Value
\u25b8 Optional stringify(value): string | string[]
value Value"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#returns_1","title":"Returns","text":"string | string[]
@k8slens/extensions / Exports / Renderer / Navigation / URLParams
"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#interface-urlparamsp-q","title":"Interface: URLParams<P, Q>","text":"Renderer.Navigation.URLParams
"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#type-parameters","title":"Type parameters","text":"Name TypeP extends object = {} Q extends object = {}"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#properties","title":"Properties","text":"\u2022 Optional fragment: string
\u2022 Optional params: P
\u2022 Optional query: Q
@k8slens/extensions / Exports / Renderer / Theme / LensTheme
"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#interface-lenstheme","title":"Interface: LensTheme","text":"Renderer.Theme.LensTheme
"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#properties","title":"Properties","text":"\u2022 author: string
\u2022 colors: Record<LensColorName, string>
\u2022 description: string
\u2022 Optional isDefault: boolean
\u2022 monacoTheme: MonacoTheme
\u2022 name: string
\u2022 terminalColors: Partial<Record<TerminalColorName, string>>
\u2022 type: LensThemeType
@k8slens/extensions / Exports / Common / Catalog
"},{"location":"extensions/api/modules/Common.Catalog/#namespace-catalog","title":"Namespace: Catalog","text":"Common.Catalog
"},{"location":"extensions/api/modules/Common.Catalog/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.Catalog/#classes","title":"Classes","text":"\u01ac AddMenuFilter: (menu: CatalogEntityAddMenu) => any
\u25b8 (menu): any
If the filter return a thruthy value, the menu item is displayed
"},{"location":"extensions/api/modules/Common.Catalog/#parameters","title":"Parameters","text":"Name Typemenu CatalogEntityAddMenu"},{"location":"extensions/api/modules/Common.Catalog/#returns","title":"Returns","text":"any
\u01ac CatalogEntityConstructor<Entity>: (data: CatalogEntityDataFor<Entity>) => Entity
Entity extends CatalogEntity"},{"location":"extensions/api/modules/Common.Catalog/#type-declaration_1","title":"Type declaration","text":"\u2022 (data)
data CatalogEntityDataFor<Entity>"},{"location":"extensions/api/modules/Common.Catalog/#catalogentitydatafor","title":"CatalogEntityDataFor","text":"\u01ac CatalogEntityDataFor<Entity>: Entity extends CatalogEntity<infer Metadata, infer Status, infer Spec> ? CatalogEntityData<Metadata, Status, Spec> : never
Entity"},{"location":"extensions/api/modules/Common.Catalog/#catalogentityinstancefrom","title":"CatalogEntityInstanceFrom","text":"\u01ac CatalogEntityInstanceFrom<Constructor>: Constructor extends CatalogEntityConstructor<infer Entity> ? Entity : never
Constructor"},{"location":"extensions/api/modules/Common.Catalog/#catalogentityspec","title":"CatalogEntitySpec","text":"\u01ac CatalogEntitySpec: Record<string, any>
\u01ac EntityMetadataObject: { [Key in string]?: EntityMetadataValue }
"},{"location":"extensions/api/modules/Common.Catalog/#entitymetadatavalue","title":"EntityMetadataValue","text":"\u01ac EntityMetadataValue: string | number | boolean | EntityMetadataObject | undefined
\u01ac KubernetesClusterStatusPhase: \"connected\" | \"connecting\" | \"disconnected\" | \"deleting\"
Deprecated
This is no longer used as it is incorrect. Other sources can add more values
"},{"location":"extensions/api/modules/Common.Catalog/#weblinkstatusphase","title":"WebLinkStatusPhase","text":"\u01ac WebLinkStatusPhase: \"available\" | \"unavailable\"
\u2022 Const kubernetesClusterCategory: KubernetesClusterCategory
\u25b8 categoryVersion<T, Metadata, Status, Spec>(name, entityClass): CatalogCategoryVersion
T extends CatalogEntity<Metadata, Status, Spec, T> Metadata extends CatalogEntityMetadata<Metadata> Status extends CatalogEntityStatus Spec extends CatalogEntitySpec"},{"location":"extensions/api/modules/Common.Catalog/#parameters_2","title":"Parameters","text":"Name Type name string entityClass (data: CatalogEntityData<Metadata, Status, Spec>) => T"},{"location":"extensions/api/modules/Common.Catalog/#returns_1","title":"Returns","text":"CatalogCategoryVersion
@k8slens/extensions / Exports / Common / EventBus
"},{"location":"extensions/api/modules/Common.EventBus/#namespace-eventbus","title":"Namespace: EventBus","text":"Common.EventBus
"},{"location":"extensions/api/modules/Common.EventBus/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.EventBus/#classes","title":"Classes","text":"\u01ac EventEmitterCallback<D>: (...data: D) => void | boolean
D extends any[]"},{"location":"extensions/api/modules/Common.EventBus/#type-declaration","title":"Type declaration","text":"\u25b8 (...data): void | boolean
...data D"},{"location":"extensions/api/modules/Common.EventBus/#returns","title":"Returns","text":"void | boolean
\u2022 Const appEventBus: EventEmitter<[AppEvent]>
@k8slens/extensions / Exports / Common / Proxy
"},{"location":"extensions/api/modules/Common.Proxy/#namespace-proxy","title":"Namespace: Proxy","text":"Common.Proxy
"},{"location":"extensions/api/modules/Common.Proxy/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.Proxy/#functions","title":"Functions","text":"\u25b8 resolveSystemProxy(url): Promise<string>
Resolves URL-specific proxy information from system. See more here: https://www.electronjs.org/docs/latest/api/session#sesresolveproxyurl
"},{"location":"extensions/api/modules/Common.Proxy/#parameters","title":"Parameters","text":"Name Type Descriptionurl string The URL for proxy information"},{"location":"extensions/api/modules/Common.Proxy/#returns","title":"Returns","text":"Promise<string>
Promise for proxy information as string
"},{"location":"extensions/api/modules/Common.Store/","title":"Common.Store","text":"@k8slens/extensions / Exports / Common / Store
"},{"location":"extensions/api/modules/Common.Store/#namespace-store","title":"Namespace: Store","text":"Common.Store
"},{"location":"extensions/api/modules/Common.Store/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.Store/#classes","title":"Classes","text":"@k8slens/extensions / Exports / Common / Types
"},{"location":"extensions/api/modules/Common.Types/#namespace-types","title":"Namespace: Types","text":"Common.Types
"},{"location":"extensions/api/modules/Common.Types/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.Types/#interfaces","title":"Interfaces","text":"\u01ac IpcMainEvent: Electron.IpcMainEvent
\u01ac IpcMainInvokeEvent: Electron.IpcMainInvokeEvent
Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.
"},{"location":"extensions/api/modules/Common.Types/#ipcrendererevent","title":"IpcRendererEvent","text":"\u01ac IpcRendererEvent: Electron.IpcRendererEvent
\u01ac KubeObjectHandlerRegistration: { apiVersions: string[] ; kind: string } & RequireAtLeastOne<KubeObjectHandlers>
\u01ac KubeObjectOnContextMenuOpen: (ctx: KubeObjectOnContextMenuOpenContext) => void
\u25b8 (ctx): void
ctx KubeObjectOnContextMenuOpenContext"},{"location":"extensions/api/modules/Common.Types/#returns","title":"Returns","text":"void
\u01ac MenuRegistration: { parentId: string ; visible?: IComputedValue<boolean> | boolean } & Omit<MenuItemConstructorOptions, \"visible\">
\u01ac ShellEnvModifier: (ctx: ShellEnvContext, env: Record<string, string | undefined>) => Record<string, string | undefined>
\u25b8 (ctx, env): Record<string, string | undefined>
ctx ShellEnvContext env Record<string, string | undefined>"},{"location":"extensions/api/modules/Common.Types/#returns_1","title":"Returns","text":"Record<string, string | undefined>
@k8slens/extensions / Exports / Common / Util
"},{"location":"extensions/api/modules/Common.Util/#namespace-util","title":"Namespace: Util","text":"Common.Util
"},{"location":"extensions/api/modules/Common.Util/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common.Util/#classes","title":"Classes","text":"\u01ac IClassName: string | string[] | Record<string, any> | undefined | null | false | IgnoredClassNames
\u01ac IgnoredClassNames: number | symbol | Function
Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.
"},{"location":"extensions/api/modules/Common.Util/#openlinkinbrowser","title":"OpenLinkInBrowser","text":"\u01ac OpenLinkInBrowser: (url: string) => Promise<void>
\u25b8 (url): Promise<void>
url string"},{"location":"extensions/api/modules/Common.Util/#returns","title":"Returns","text":"Promise<void>
\u25b8 cssNames(...classNames): string
...classNames IClassName[]"},{"location":"extensions/api/modules/Common.Util/#returns_1","title":"Returns","text":"string
\u25b8 disposer(...items): ExtendableDisposer
...items SingleOrMany<undefined | null | Disposer | Disposable>[]"},{"location":"extensions/api/modules/Common.Util/#returns_2","title":"Returns","text":"ExtendableDisposer
\u25b8 getAppVersion(): string
string
\u25b8 openBrowser(url): Promise<void>
url string"},{"location":"extensions/api/modules/Common.Util/#returns_4","title":"Returns","text":"Promise<void>
\u25b8 openExternal(url): Promise<void>
url string"},{"location":"extensions/api/modules/Common.Util/#returns_5","title":"Returns","text":"Promise<void>
\u25b8 prevDefault<E, R>(callback): (event: E) => R
E extends Event | SyntheticEvent<Element, Event> R R"},{"location":"extensions/api/modules/Common.Util/#parameters_5","title":"Parameters","text":"Name Type callback (evt: E) => R"},{"location":"extensions/api/modules/Common.Util/#returns_6","title":"Returns","text":"fn
\u25b8 (event): R
event E"},{"location":"extensions/api/modules/Common.Util/#returns_7","title":"Returns","text":"R
\u25b8 stopPropagation(evt): void
evt Event | SyntheticEvent<Element, Event>"},{"location":"extensions/api/modules/Common.Util/#returns_8","title":"Returns","text":"void
@k8slens/extensions / Exports / Common
"},{"location":"extensions/api/modules/Common/#namespace-common","title":"Namespace: Common","text":"Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.
"},{"location":"extensions/api/modules/Common/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Common/#namespaces","title":"Namespaces","text":"\u01ac InstalledExtension: BundledInstalledExtension | ExternalInstalledExtension
\u2022 Const App: Object
Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.
"},{"location":"extensions/api/modules/Common/#type-declaration","title":"Type declaration","text":"Name Type DescriptionPreferences { getKubectlPath: () => string | undefined } - Preferences.getKubectlPath () => string | undefined - appName string - getEnabledExtensions () => string[] - isLinux boolean - isMac boolean - isSnap boolean - isWindows boolean - issuesTrackerUrl string - lensBuildEnvironment string - slackUrl \"\" Deprecated This value is now \"\" and is left here for backwards compatibility. version string -"},{"location":"extensions/api/modules/Common/#logger","title":"logger","text":"\u2022 Const logger: Logger
@k8slens/extensions / Exports / Main / Catalog
"},{"location":"extensions/api/modules/Main.Catalog/#namespace-catalog","title":"Namespace: Catalog","text":"Main.Catalog
Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.
"},{"location":"extensions/api/modules/Main.Catalog/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Main.Catalog/#interfaces","title":"Interfaces","text":"\u2022 Const catalogCategories: CatalogCategoryRegistry
\u2022 Const catalogEntities: CatalogEntityRegistry
@k8slens/extensions / Exports / Main / K8sApi
"},{"location":"extensions/api/modules/Main.K8sApi/#namespace-k8sapi","title":"Namespace: K8sApi","text":"Main.K8sApi
"},{"location":"extensions/api/modules/Main.K8sApi/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Main.K8sApi/#references","title":"References","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Main.K8sApi/#isjsonapidata","title":"isJsonApiData","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Main.K8sApi/#isjsonapidatalist","title":"isJsonApiDataList","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Main.K8sApi/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Main.K8sApi/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Main.K8sApi/#iskubeobjectnonsystem","title":"isKubeObjectNonSystem","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Main.K8sApi/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Main.K8sApi/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Main.K8sApi/#stringifylabels","title":"stringifyLabels","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Main.K8sApi/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Main.K8sApi/#clusterscopedmetadata","title":"ClusterScopedMetadata","text":"\u01ac ClusterScopedMetadata: KubeObjectMetadata<KubeObjectScope.Cluster>
\u01ac DeploymentApi: InternalDeploymentApi
\u01ac IngressApi: InternalIngressApi
\u01ac JsonPatch: Patch
\u01ac KubeApi<Object, Data>: InternalKubeApi<Object, Data>
Object extends KubeObject = KubeObject Data extends KubeJsonApiDataFor<Object> = KubeJsonApiDataFor<Object>"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapi","title":"KubeJsonApi","text":"\u01ac KubeJsonApi: InternalKubeJsonApi
\u01ac KubeJsonApiDataFor<K>: K extends KubeObject<infer Metadata, infer Status, infer Spec> ? KubeJsonApiData<Metadata, Status, Spec> : never
K"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapiobjectmetadata","title":"KubeJsonApiObjectMetadata","text":"\u01ac KubeJsonApiObjectMetadata<Namespaced>: BaseKubeJsonApiObjectMetadata<Namespaced> & Namespaced extends KubeObjectScope.Namespace ? { namespace: string } : {}
Namespaced extends KubeObjectScope = KubeObjectScope"},{"location":"extensions/api/modules/Main.K8sApi/#kubeobjectmetadata","title":"KubeObjectMetadata","text":"\u01ac KubeObjectMetadata<Namespaced>: KubeJsonApiObjectMetadata<Namespaced> & { selfLink: string }
Namespaced extends KubeObjectScope = KubeObjectScope"},{"location":"extensions/api/modules/Main.K8sApi/#namespacescopedmetadata","title":"NamespaceScopedMetadata","text":"\u01ac NamespaceScopedMetadata: KubeObjectMetadata<KubeObjectScope.Namespace>
\u01ac NodesApi: NodeApi
\u01ac PersistentVolumeClaimsApi: PersistentVolumeClaimApi
\u01ac PodsApi: PodApi
\u2022 DeploymentApi: (opts?: DerivedKubeApiOptions) => DeploymentApi
\u2022 new DeploymentApi(opts?)
opts? DerivedKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#ingressapi_1","title":"IngressApi","text":"\u2022 IngressApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => IngressApi
\u2022 new IngressApi(opts?)
opts? DerivedKubeApiOptions & IgnoredKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#kubeapi_1","title":"KubeApi","text":"\u2022 KubeApi: <Object_1, Data>(opts: KubeApiOptions<Object_1, Data> & ExternalKubeApiOptions) => KubeApi<Object_1, Data>
\u2022 new KubeApi<Object_1, Data>(opts)
Object_1 extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object_1> = KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> Data extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data> = KubeJsonApiDataFor<Object_1>"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_2","title":"Parameters","text":"Name Type opts KubeApiOptions<Object_1, Data> & ExternalKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapi_1","title":"KubeJsonApi","text":"\u2022 KubeJsonApi: (config: JsonApiConfig, reqInit?: RequestInit) => KubeJsonApi & { forCluster: CreateKubeJsonApiForCluster }
\u2022 NodesApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => NodeApi
\u2022 new NodesApi(opts?)
opts? DerivedKubeApiOptions & IgnoredKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#persistentvolumeclaimsapi_1","title":"PersistentVolumeClaimsApi","text":"\u2022 PersistentVolumeClaimsApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => PersistentVolumeClaimApi
\u2022 new PersistentVolumeClaimsApi(opts?)
opts? DerivedKubeApiOptions & IgnoredKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#podsapi_1","title":"PodsApi","text":"\u2022 PodsApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => PodApi
\u2022 new PodsApi(opts?)
opts? DerivedKubeApiOptions & IgnoredKubeApiOptions"},{"location":"extensions/api/modules/Main.K8sApi/#apimanager","title":"apiManager","text":"\u2022 Const apiManager: ApiManager
\u25b8 createResourceStack(cluster, name): ResourceApplyingStack
cluster KubernetesCluster<KubernetesClusterMetadata, KubernetesClusterStatus, KubernetesClusterSpec> name string"},{"location":"extensions/api/modules/Main.K8sApi/#returns","title":"Returns","text":"ResourceApplyingStack
\u25b8 forCluster<Object, Api, Data>(cluster, kubeClass, apiClass): Api
Object extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> Api extends KubeApi<Object, KubeJsonApiDataFor<Object>, Api> Data extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data>"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_7","title":"Parameters","text":"Name Type cluster ILocalKubeApiConfig kubeClass KubeObjectConstructor<Object, Data> apiClass KubeApiConstructor<Object, Api>"},{"location":"extensions/api/modules/Main.K8sApi/#returns_1","title":"Returns","text":"Api
\u25b8 forCluster<Object, Data>(cluster, kubeClass, apiClass?): KubeApi<Object, KubeJsonApiDataFor<Object>>
Object extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> Data extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data>"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_8","title":"Parameters","text":"Name Type cluster ILocalKubeApiConfig kubeClass KubeObjectConstructor<Object, Data> apiClass? KubeApiConstructor<Object, KubeApi<Object, KubeJsonApiDataFor<Object>>>"},{"location":"extensions/api/modules/Main.K8sApi/#returns_2","title":"Returns","text":"KubeApi<Object, KubeJsonApiDataFor<Object>>
\u25b8 forRemoteCluster<Object, Api, Data>(config, kubeClass, apiClass): Api
Object extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> Api extends KubeApi<Object, KubeJsonApiDataFor<Object>, Api> Data extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data>"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_9","title":"Parameters","text":"Name Type config IRemoteKubeApiConfig kubeClass KubeObjectConstructor<Object, Data> apiClass KubeApiConstructor<Object, Api>"},{"location":"extensions/api/modules/Main.K8sApi/#returns_3","title":"Returns","text":"Api
\u25b8 forRemoteCluster<Object, Data>(config, kubeClass, apiClass?): KubeApi<Object, KubeJsonApiDataFor<Object>>
Object extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> Data extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data>"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_10","title":"Parameters","text":"Name Type config IRemoteKubeApiConfig kubeClass KubeObjectConstructor<Object, Data> apiClass? KubeApiConstructor<Object, KubeApi<Object, KubeJsonApiDataFor<Object>>>"},{"location":"extensions/api/modules/Main.K8sApi/#returns_4","title":"Returns","text":"KubeApi<Object, KubeJsonApiDataFor<Object>>
\u25b8 getPodsByOwnerId(ownerId): Pod[]
ownerId string"},{"location":"extensions/api/modules/Main.K8sApi/#returns_5","title":"Returns","text":"Pod[]
\u25b8 isAllowedResource(...args): boolean
Deprecated
This function never works
"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_12","title":"Parameters","text":"Name Type...args any[]"},{"location":"extensions/api/modules/Main.K8sApi/#returns_6","title":"Returns","text":"boolean
false
"},{"location":"extensions/api/modules/Main.K8sApi/#iskubestatusdata","title":"isKubeStatusData","text":"\u25b8 isKubeStatusData(object): object is KubeStatusData
Is the shape of object correct for KubeStatusData
"},{"location":"extensions/api/modules/Main.K8sApi/#parameters_13","title":"Parameters","text":"Name Type Descriptionobject unknown Some object"},{"location":"extensions/api/modules/Main.K8sApi/#returns_7","title":"Returns","text":"object is KubeStatusData
"},{"location":"extensions/api/modules/Main.Navigation/","title":"Main.Navigation","text":"@k8slens/extensions / Exports / Main / Navigation
"},{"location":"extensions/api/modules/Main.Navigation/#namespace-navigation","title":"Namespace: Navigation","text":"Main.Navigation
"},{"location":"extensions/api/modules/Main.Navigation/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Main.Navigation/#functions","title":"Functions","text":"\u25b8 navigate(url): Promise<void>
Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.
"},{"location":"extensions/api/modules/Main.Navigation/#parameters","title":"Parameters","text":"Name Typeurl string"},{"location":"extensions/api/modules/Main.Navigation/#returns","title":"Returns","text":"Promise<void>
@k8slens/extensions / Exports / Main / Power
"},{"location":"extensions/api/modules/Main.Power/#namespace-power","title":"Namespace: Power","text":"Main.Power
"},{"location":"extensions/api/modules/Main.Power/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Main.Power/#type-aliases","title":"Type Aliases","text":"\u01ac PowerEventListener: () => void
\u25b8 (): void
Event listener for system power events
"},{"location":"extensions/api/modules/Main.Power/#returns","title":"Returns","text":"void
\u25b8 onResume(listener): Disposer
Adds event listener to system resume event
"},{"location":"extensions/api/modules/Main.Power/#parameters","title":"Parameters","text":"Name Type Descriptionlistener PowerEventListener function which will be called on system resume"},{"location":"extensions/api/modules/Main.Power/#returns_1","title":"Returns","text":"Disposer
function to remove event listener
"},{"location":"extensions/api/modules/Main.Power/#onshutdown","title":"onShutdown","text":"\u25b8 onShutdown(listener): Disposer
Adds event listener to the event which is emitted when the system is about to reboot or shut down
"},{"location":"extensions/api/modules/Main.Power/#parameters_1","title":"Parameters","text":"Name Type Descriptionlistener PowerEventListener function which will be called on system shutdown"},{"location":"extensions/api/modules/Main.Power/#returns_2","title":"Returns","text":"Disposer
function to remove event listener
"},{"location":"extensions/api/modules/Main.Power/#onsuspend","title":"onSuspend","text":"\u25b8 onSuspend(listener): Disposer
Adds event listener to system suspend events
"},{"location":"extensions/api/modules/Main.Power/#parameters_2","title":"Parameters","text":"Name Type Descriptionlistener PowerEventListener function which will be called on system suspend"},{"location":"extensions/api/modules/Main.Power/#returns_3","title":"Returns","text":"Disposer
function to remove event listener
"},{"location":"extensions/api/modules/Main/","title":"Main","text":"@k8slens/extensions / Exports / Main
"},{"location":"extensions/api/modules/Main/#namespace-main","title":"Namespace: Main","text":"Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.
"},{"location":"extensions/api/modules/Main/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Main/#namespaces","title":"Namespaces","text":"@k8slens/extensions / Exports / Renderer / Catalog
"},{"location":"extensions/api/modules/Renderer.Catalog/#namespace-catalog","title":"Namespace: Catalog","text":"Renderer.Catalog
"},{"location":"extensions/api/modules/Renderer.Catalog/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer.Catalog/#classes","title":"Classes","text":"\u2022 Const activeCluster: IComputedValue
\u2022 Const catalogCategories: CatalogCategoryRegistry
\u2022 Const catalogEntities: CatalogEntityRegistry
@k8slens/extensions / Exports / Renderer / Component
"},{"location":"extensions/api/modules/Renderer.Component/#namespace-component","title":"Namespace: Component","text":"Renderer.Component
"},{"location":"extensions/api/modules/Renderer.Component/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer.Component/#references","title":"References","text":"Re-exports CategoryColumnRegistration
"},{"location":"extensions/api/modules/Renderer.Component/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Renderer.Component/#atleastonemetrictab","title":"AtLeastOneMetricTab","text":"\u01ac AtLeastOneMetricTab: [MetricsTab, ...MetricsTab[]]
\u01ac DatasetTooltipLabel: (percent: string) => string | string
\u25b8 (percent): string | string
percent string"},{"location":"extensions/api/modules/Renderer.Component/#returns","title":"Returns","text":"string | string
\u01ac DrawerPosition: \"top\" | \"left\" | \"right\" | \"bottom\"
\u01ac IconData: string | StrictReactNode | (opt: IconDataFnArg) => StrictReactNode
One of the following: - A material icon name - A react node - Or a function that produces a react node
"},{"location":"extensions/api/modules/Renderer.Component/#inputprops","title":"InputProps","text":"\u01ac InputProps: Omit<InputElementProps, \"onChange\" | \"onSubmit\"> & { autoSelectOnFocus?: boolean ; blurOnEnter?: boolean ; className?: string ; contentRight?: string | StrictReactNode ; defaultValue?: string ; dirty?: boolean ; iconLeft?: IconData ; iconRight?: IconData ; maxRows?: number ; multiLine?: boolean ; showErrorsAsTooltip?: boolean | Omit<TooltipProps, \"targetId\"> ; showValidationLine?: boolean ; theme?: \"round-black\" | \"round\" ; trim?: boolean ; validators?: SingleOrMany<InputValidator> ; value?: string ; onChange?: (value: string, evt: ChangeEvent<InputElement>) => void ; onSubmit?: (value: string, evt: KeyboardEvent<InputElement>) => void }
\u01ac InputValidation<IsAsync>: (value: string, props?: InputProps) => InputValidationResult<IsAsync>
IsAsync extends boolean"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration_1","title":"Type declaration","text":"\u25b8 (value, props?): InputValidationResult<IsAsync>
value string props? InputProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_1","title":"Returns","text":"InputValidationResult<IsAsync>
\u01ac InputValidationResult<IsAsync>: IsAsync extends true ? Promise<void> : boolean
IsAsync extends boolean"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidator","title":"InputValidator","text":"\u01ac InputValidator<IsAsync>: SyncInputValidator | AsyncInputValidator | IsAsync extends boolean ? LegacyInputValidator : never
IsAsync extends boolean = boolean"},{"location":"extensions/api/modules/Renderer.Component/#kubeitemliststore","title":"KubeItemListStore","text":"\u01ac KubeItemListStore<K>: ItemListStore<K, false> & SubscribableStore & { contextItems: K[] ; getByPath: (path: string) => K | undefined }
K extends KubeObject"},{"location":"extensions/api/modules/Renderer.Component/#legacyautoconvertedoptions","title":"LegacyAutoConvertedOptions","text":"\u01ac LegacyAutoConvertedOptions: string[]
Deprecated
This should not be used anymore, convert the options yourself.
"},{"location":"extensions/api/modules/Renderer.Component/#monacocustomtheme","title":"MonacoCustomTheme","text":"\u01ac MonacoCustomTheme: \"clouds-midnight\"
\u01ac MonacoEditorId: string
\u01ac MonacoTheme: \"vs\" | \"vs-dark\" | \"hc-black\" | MonacoCustomTheme
\u01ac NamedSvg: \"configuration\" | \"crane\" | \"group\" | \"helm\" | \"install\" | \"kube\" | \"lens-logo\" | \"license\" | \"logo-lens\" | \"logout\" | \"nodes\" | \"push_off\" | \"push_pin\" | \"spinner\" | \"ssh\" | \"storage\" | \"terminal\" | \"user\" | \"users\" | \"wheel\" | \"workloads\"
\u01ac NamespaceSelectSort: (left: string, right: string) => number
\u25b8 (left, right): number
left string right string"},{"location":"extensions/api/modules/Renderer.Component/#returns_2","title":"Returns","text":"number
\u01ac NotificationId: string | number
\u01ac NotificationMessage: string | React.ReactElement | React.ReactElement[] | JsonApiErrorParsed | Error
\u01ac ShowNotification: (message: NotificationMessage, opts?: CreateNotificationOptions) => Disposer
\u25b8 (message, opts?): Disposer
message NotificationMessage opts? CreateNotificationOptions"},{"location":"extensions/api/modules/Renderer.Component/#returns_3","title":"Returns","text":"Disposer
\u01ac SyncValidationMessage: StrictReactNode | (value: string, props?: InputProps) => StrictReactNode
\u01ac TableCellElem: React.ReactElement<TableCellProps>
\u01ac TableHeadElem: React.ReactElement<TableHeadProps>
\u01ac TableOrderBy: \"asc\" | \"desc\"
\u01ac TableRowElem<Item>: React.ReactElement<TableRowProps<Item>>
Item"},{"location":"extensions/api/modules/Renderer.Component/#tablesortby","title":"TableSortBy","text":"\u01ac TableSortBy: string
\u01ac TableSortCallback<Item>: (data: Item) => undefined | string | number | (string | number)[]
Item"},{"location":"extensions/api/modules/Renderer.Component/#type-declaration_4","title":"Type declaration","text":"\u25b8 (data): undefined | string | number | (string | number)[]
data Item"},{"location":"extensions/api/modules/Renderer.Component/#returns_4","title":"Returns","text":"undefined | string | number | (string | number)[]
\u01ac TableSortCallbacks<Item>: Record<string, TableSortCallback<Item>>
Item"},{"location":"extensions/api/modules/Renderer.Component/#variables_1","title":"Variables","text":""},{"location":"extensions/api/modules/Renderer.Component/#commandoverlay","title":"CommandOverlay","text":"\u2022 Const CommandOverlay: CommandOverlay
\u2022 Const InputValidators: Object
accountId Validators.SyncInputValidator isEmail Validators.SyncInputValidator isExtensionNameInstall Validators.SyncInputValidator isExtensionNameInstallRegex { captures: (val: string) => undefined | { name: string ; version?: string } ; isMatch: (val: string) => boolean } isExtensionNameInstallRegex.captures [object Object] isExtensionNameInstallRegex.isMatch [object Object] isNumber Validators.SyncInputValidator isPath Validators.AsyncInputValidator isRequired Validators.SyncInputValidator isUrl Validators.SyncInputValidator maxLength Validators.SyncInputValidator minLength Validators.SyncInputValidator systemName Validators.SyncInputValidator unionInputValidators (baseValidator: Pick<SyncInputValidator, \"message\" | \"condition\">, ...validators: SyncInputValidator[]) => SyncInputValidator"},{"location":"extensions/api/modules/Renderer.Component/#menucontext","title":"MenuContext","text":"\u2022 Const MenuContext: React.Context<MenuContextValue | null>
\u2022 Const Notifications: Object
checkedError ShowCheckedErrorNotification error ShowNotification info ShowNotification ok ShowNotification shortInfo ShowNotification"},{"location":"extensions/api/modules/Renderer.Component/#resourcemetricscontext","title":"ResourceMetricsContext","text":"\u2022 Const ResourceMetricsContext: React.Context<ResourceMetricsValue | null>
\u2022 Const Tooltip: React.ComponentClass<TooltipProps, any>
\u2022 Const cpuOptions: ChartOptions
\u2022 Const logTabStore: LogTabStore & { createPodTab: ({ selectedPod, selectedContainer }: PodLogsTabData) => string ; createWorkloadTab: ({ workload }: WorkloadLogsTabData) => string | undefined ; renameTab: (tabId: string) => void ; tabs: undefined }
\u2022 Const memoryOptions: ChartOptions
\u2022 Const notificationsStore: NotificationsStore
\u2022 Const podMetricTabs: AtLeastOneMetricTab
\u2022 Const resizingAnchorProps: Record<DrawerPosition, [ResizeDirection, ResizeSide, ResizeGrowthDirection]>
\u2022 Const terminalStore: TerminalStore & { sendCommand: SendCommand }
\u25b8 Badge(props, context?): null | ReactElement<any, any>
props PropsWithChildren<BadgeProps & TooltipDecoratorProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_5","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 BarChart(props, context?): null | ReactElement<any, any>
props PropsWithChildren<BarChartProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_6","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 Button(props, context?): null | ReactElement<any, any>
props PropsWithChildren<ButtonProps & TooltipDecoratorProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_7","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 Checkbox(\u00abdestructured\u00bb): React.JSX.Element
\u00abdestructured\u00bb CheckboxProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_8","title":"Returns","text":"React.JSX.Element
\u25b8 ConfirmDialog(props, context?): null | ReactElement<any, any>
props PropsWithChildren<ConfirmDialogProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_9","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 Dialog(props, context?): null | ReactElement<any, any>
props PropsWithChildren<DialogProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_10","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 Drawer(props, context?): null | ReactElement<any, any>
props PropsWithChildren<DrawerProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_11","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 DrawerItem(\u00abdestructured\u00bb): React.JSX.Element | null
\u00abdestructured\u00bb DrawerItemProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_12","title":"Returns","text":"React.JSX.Element | null
\u25b8 DrawerItemLabels(props): React.JSX.Element | null
props DrawerItemLabelsProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_13","title":"Returns","text":"React.JSX.Element | null
\u25b8 DrawerTitle(\u00abdestructured\u00bb): React.JSX.Element
\u00abdestructured\u00bb DrawerTitleProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_14","title":"Returns","text":"React.JSX.Element
\u25b8 FormSwitch(props): React.FunctionComponentElement<any>
Deprecated
Use instead from \"../switch.tsx\".
"},{"location":"extensions/api/modules/Renderer.Component/#parameters_15","title":"Parameters","text":"Name Typeprops FormControlLabelProps & { children?: StrictReactNode }"},{"location":"extensions/api/modules/Renderer.Component/#returns_15","title":"Returns","text":"React.FunctionComponentElement<any>
\u25b8 Icon(props, context?): null | ReactElement<any, any>
props PropsWithChildren<IconProps & TooltipDecoratorProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_16","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 KubeEventDetails(props, context?): null | ReactElement<any, any>
props PropsWithChildren<KubeEventDetailsProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_17","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 KubeObjectDetails(props, context?): null | ReactElement<any, any>
props Object context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_18","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 KubeObjectListLayout<K, A, D>(props): ReactElement<any, string | JSXElementConstructor<any>>
K extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, K> A extends KubeApi<K, D, A> D extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, D> = KubeJsonApiDataFor<K>"},{"location":"extensions/api/modules/Renderer.Component/#parameters_19","title":"Parameters","text":"Name Type props KubeObjectListLayoutProps<K, A, D>"},{"location":"extensions/api/modules/Renderer.Component/#returns_19","title":"Returns","text":"ReactElement<any, string | JSXElementConstructor<any>>
\u25b8 KubeObjectMenu<T>(props): ReactElement<any, string | JSXElementConstructor<any>>
T extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, T>"},{"location":"extensions/api/modules/Renderer.Component/#parameters_20","title":"Parameters","text":"Name Type props KubeObjectMenuProps<T>"},{"location":"extensions/api/modules/Renderer.Component/#returns_20","title":"Returns","text":"ReactElement<any, string | JSXElementConstructor<any>>
\u25b8 KubeObjectMeta(props, context?): null | ReactElement<any, any>
props PropsWithChildren<KubeObjectMetaProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_21","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 LineProgress(props, context?): null | ReactElement<any, any>
props PropsWithChildren<LineProgressProps & TooltipDecoratorProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_22","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 MainLayout(props, context?): null | ReactElement<any, any>
props PropsWithChildren<MainLayoutProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_23","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 Menu(props, context?): null | ReactElement<any, any>
props PropsWithChildren<MenuProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_24","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 MenuActions(props, context?): null | ReactElement<any, any>
props PropsWithChildren<MenuActionsProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_25","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 MonacoEditor(props): null | ReactElement<any, string | JSXElementConstructor<any>>
NOTE: Exotic components are not callable.
"},{"location":"extensions/api/modules/Renderer.Component/#parameters_26","title":"Parameters","text":"Name Typeprops MonacoEditorProps & RefAttributes<MonacoEditorRef>"},{"location":"extensions/api/modules/Renderer.Component/#returns_26","title":"Returns","text":"null | ReactElement<any, string | JSXElementConstructor<any>>
\u25b8 NamespaceSelect<IsMulti>(props): JSX.Element
IsMulti extends boolean = false"},{"location":"extensions/api/modules/Renderer.Component/#parameters_27","title":"Parameters","text":"Name Type props NamespaceSelectProps<IsMulti>"},{"location":"extensions/api/modules/Renderer.Component/#returns_27","title":"Returns","text":"JSX.Element
\u25b8 NamespaceSelectFilter(props, context?): null | ReactElement<any, any>
props PropsWithChildren<NamespaceSelectFilterProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_28","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 PieChart(props, context?): null | ReactElement<any, any>
props PropsWithChildren<PieChartProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_29","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 PodCharts(): null | Element
null | Element
\u25b8 PodDetailsList(props, context?): null | ReactElement<any, any>
props PropsWithChildren<PodDetailsListProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_31","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 Radio<T>(\u00abdestructured\u00bb): React.JSX.Element
T"},{"location":"extensions/api/modules/Renderer.Component/#parameters_31","title":"Parameters","text":"Name Type \u00abdestructured\u00bb RadioProps<T>"},{"location":"extensions/api/modules/Renderer.Component/#returns_32","title":"Returns","text":"React.JSX.Element
\u25b8 RadioGroup<T>(\u00abdestructured\u00bb): React.JSX.Element
T"},{"location":"extensions/api/modules/Renderer.Component/#parameters_32","title":"Parameters","text":"Name Type \u00abdestructured\u00bb RadioGroupProps<T>"},{"location":"extensions/api/modules/Renderer.Component/#returns_33","title":"Returns","text":"React.JSX.Element
\u25b8 ResourceMetrics<Keys>(\u00abdestructured\u00bb): Element
Keys extends string"},{"location":"extensions/api/modules/Renderer.Component/#parameters_33","title":"Parameters","text":"Name Type \u00abdestructured\u00bb ResourceMetricsProps<Keys>"},{"location":"extensions/api/modules/Renderer.Component/#returns_34","title":"Returns","text":"Element
\u25b8 SearchInput(props, context?): null | ReactElement<any, any>
props PropsWithChildren<SearchInputProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_35","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 Select<Value, Option, IsMulti, Group>(props): ReactElement<any, string | JSXElementConstructor<any>>
Value Value Option extends SelectOption<Value, Option> IsMulti extends boolean = false Group extends GroupBase<Option, Group> = GroupBase<Option>"},{"location":"extensions/api/modules/Renderer.Component/#parameters_35","title":"Parameters","text":"Name Type props SelectProps<Value, Option, IsMulti, Group>"},{"location":"extensions/api/modules/Renderer.Component/#returns_36","title":"Returns","text":"ReactElement<any, string | JSXElementConstructor<any>>
\u25b8 StatusBrick(props, context?): null | ReactElement<any, any>
props PropsWithChildren<StatusBrickProps & TooltipDecoratorProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_37","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 SubMenu(props): React.JSX.Element
props Partial<MenuProps>"},{"location":"extensions/api/modules/Renderer.Component/#returns_38","title":"Returns","text":"React.JSX.Element
\u25b8 Switch(\u00abdestructured\u00bb): React.JSX.Element
\u00abdestructured\u00bb SwitchProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_39","title":"Returns","text":"React.JSX.Element
\u25b8 Switcher(\u00abdestructured\u00bb): React.JSX.Element
Deprecated
Use instead from \"../switch.tsx\".
"},{"location":"extensions/api/modules/Renderer.Component/#parameters_39","title":"Parameters","text":"Name Type\u00abdestructured\u00bb SwitcherProps"},{"location":"extensions/api/modules/Renderer.Component/#returns_40","title":"Returns","text":"React.JSX.Element
\u25b8 TabLayout(props, context?): null | ReactElement<any, any>
props PropsWithChildren<TabLayoutProps> context? any"},{"location":"extensions/api/modules/Renderer.Component/#returns_41","title":"Returns","text":"null | ReactElement<any, any>
\u25b8 Table<Item>(props): ReactElement<any, string | JSXElementConstructor<any>>
Item"},{"location":"extensions/api/modules/Renderer.Component/#parameters_41","title":"Parameters","text":"Name Type props TableProps<Item>"},{"location":"extensions/api/modules/Renderer.Component/#returns_42","title":"Returns","text":"ReactElement<any, string | JSXElementConstructor<any>>
\u25b8 asyncInputValidator(validator): AsyncInputValidator
A helper function to create an AsyncInputValidator
"},{"location":"extensions/api/modules/Renderer.Component/#parameters_42","title":"Parameters","text":"Name Typevalidator AsyncInputValidator"},{"location":"extensions/api/modules/Renderer.Component/#returns_43","title":"Returns","text":"AsyncInputValidator
\u25b8 createTerminalTab(tabParams?): Required<DockTabCreate>
tabParams? DockTabCreateSpecific"},{"location":"extensions/api/modules/Renderer.Component/#returns_44","title":"Returns","text":"Required<DockTabCreate>
\u25b8 getDetailsUrl(selfLink, resetSelected?, mergeGlobals?): string
Deprecated
Use Renderer.Navigation.getDetailsUrl
selfLink string resetSelected? boolean mergeGlobals? boolean"},{"location":"extensions/api/modules/Renderer.Component/#returns_45","title":"Returns","text":"string
\u25b8 inputValidator(validator): SyncInputValidator
A helper function to create an SyncInputValidator
"},{"location":"extensions/api/modules/Renderer.Component/#parameters_45","title":"Parameters","text":"Name Typevalidator SyncInputValidator"},{"location":"extensions/api/modules/Renderer.Component/#returns_46","title":"Returns","text":"SyncInputValidator
\u25b8 isAsyncValidator(validator): validator is AsyncInputValidator
validator InputValidator<boolean>"},{"location":"extensions/api/modules/Renderer.Component/#returns_47","title":"Returns","text":"validator is AsyncInputValidator
"},{"location":"extensions/api/modules/Renderer.Component/#issvg","title":"isSvg","text":"\u25b8 isSvg(content): boolean
content string"},{"location":"extensions/api/modules/Renderer.Component/#returns_48","title":"Returns","text":"boolean
\u25b8 onMultiSelectFor<Value, Option, Group>(collection): SelectProps<Value, Option, true, Group>[\"onChange\"]
Value Value Option extends SelectOption<Value, Option> Group extends GroupBase<Option, Group> = GroupBase<Option>"},{"location":"extensions/api/modules/Renderer.Component/#parameters_48","title":"Parameters","text":"Name Type collection Set<Value> | ObservableSet<Value>"},{"location":"extensions/api/modules/Renderer.Component/#returns_49","title":"Returns","text":"SelectProps<Value, Option, true, Group>[\"onChange\"]
\u25b8 showDetails(selfLink, resetSelected?): void
Deprecated
Use Renderer.Navigation.showDetails
selfLink undefined | string resetSelected? boolean"},{"location":"extensions/api/modules/Renderer.Component/#returns_50","title":"Returns","text":"void
\u25b8 unionInputValidatorsAsync(baseValidator, ...validators): AsyncInputValidator
Create a new input validator from a list of syncronous or async input validators. Will match as valid if one of the input validators matches the input
"},{"location":"extensions/api/modules/Renderer.Component/#parameters_50","title":"Parameters","text":"Name TypebaseValidator Object baseValidator.condition undefined | (props: InputProps) => any | (props: InputProps) => any | (props: InputProps) => any baseValidator.message null | string | number | boolean | ReactPortal | ReactElement<any, string | JSXElementConstructor<any>> | StrictReactFragment | Iterable<StrictReactNode> | (value: string, props?: InputProps) => StrictReactNode ...validators InputValidator<boolean>[]"},{"location":"extensions/api/modules/Renderer.Component/#returns_51","title":"Returns","text":"AsyncInputValidator
\u25b8 withTooltip<TargetProps>(Target): React.FunctionComponent<TargetProps & TooltipDecoratorProps>
TargetProps"},{"location":"extensions/api/modules/Renderer.Component/#parameters_51","title":"Parameters","text":"Name Type Target TargetProps extends Pick<TooltipDecoratorProps, \"id\" | \"children\"> ? FunctionComponent<TargetProps> : never"},{"location":"extensions/api/modules/Renderer.Component/#returns_52","title":"Returns","text":"React.FunctionComponent<TargetProps & TooltipDecoratorProps>
@k8slens/extensions / Exports / Renderer / K8sApi
"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespace-k8sapi","title":"Namespace: K8sApi","text":"Renderer.K8sApi
"},{"location":"extensions/api/modules/Renderer.K8sApi/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer.K8sApi/#references","title":"References","text":"Re-exports BaseKubeJsonApiObjectMetadata
"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterrole","title":"ClusterRole","text":"Re-exports ClusterRole
"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterrolebinding","title":"ClusterRoleBinding","text":"Re-exports ClusterRoleBinding
"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterscopedmetadata","title":"ClusterScopedMetadata","text":"Re-exports ClusterScopedMetadata
"},{"location":"extensions/api/modules/Renderer.K8sApi/#configmap","title":"ConfigMap","text":"Re-exports ConfigMap
"},{"location":"extensions/api/modules/Renderer.K8sApi/#cronjob","title":"CronJob","text":"Re-exports CronJob
"},{"location":"extensions/api/modules/Renderer.K8sApi/#customresourcedefinition","title":"CustomResourceDefinition","text":"Re-exports CustomResourceDefinition
"},{"location":"extensions/api/modules/Renderer.K8sApi/#daemonset","title":"DaemonSet","text":"Re-exports DaemonSet
"},{"location":"extensions/api/modules/Renderer.K8sApi/#deployment","title":"Deployment","text":"Re-exports Deployment
"},{"location":"extensions/api/modules/Renderer.K8sApi/#deploymentapi","title":"DeploymentApi","text":"Re-exports DeploymentApi
"},{"location":"extensions/api/modules/Renderer.K8sApi/#endpoint","title":"Endpoint","text":"Re-exports Endpoint
"},{"location":"extensions/api/modules/Renderer.K8sApi/#externalkubeapioptions","title":"ExternalKubeApiOptions","text":"Re-exports ExternalKubeApiOptions
"},{"location":"extensions/api/modules/Renderer.K8sApi/#horizontalpodautoscaler","title":"HorizontalPodAutoscaler","text":"Re-exports HorizontalPodAutoscaler
"},{"location":"extensions/api/modules/Renderer.K8sApi/#horizontalpodautoscalerstore","title":"HorizontalPodAutoscalerStore","text":"Renames and re-exports HPAStore
"},{"location":"extensions/api/modules/Renderer.K8sApi/#ikubeapicluster","title":"IKubeApiCluster","text":"Re-exports IKubeApiCluster
"},{"location":"extensions/api/modules/Renderer.K8sApi/#ilocalkubeapiconfig","title":"ILocalKubeApiConfig","text":"Re-exports ILocalKubeApiConfig
"},{"location":"extensions/api/modules/Renderer.K8sApi/#ipodcontainer","title":"IPodContainer","text":"Re-exports IPodContainer
"},{"location":"extensions/api/modules/Renderer.K8sApi/#ipodcontainerstatus","title":"IPodContainerStatus","text":"Re-exports IPodContainerStatus
"},{"location":"extensions/api/modules/Renderer.K8sApi/#iremotekubeapiconfig","title":"IRemoteKubeApiConfig","text":"Re-exports IRemoteKubeApiConfig
"},{"location":"extensions/api/modules/Renderer.K8sApi/#isecretref","title":"ISecretRef","text":"Re-exports ISecretRef
"},{"location":"extensions/api/modules/Renderer.K8sApi/#ignoredkubeapioptions","title":"IgnoredKubeApiOptions","text":"Re-exports IgnoredKubeApiOptions
"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingress","title":"Ingress","text":"Re-exports Ingress
"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingressapi","title":"IngressApi","text":"Re-exports IngressApi
"},{"location":"extensions/api/modules/Renderer.K8sApi/#job","title":"Job","text":"Re-exports Job
"},{"location":"extensions/api/modules/Renderer.K8sApi/#jsonpatch","title":"JsonPatch","text":"Re-exports JsonPatch
"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeapi","title":"KubeApi","text":"Re-exports KubeApi
"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeevent","title":"KubeEvent","text":"Re-exports KubeEvent
"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapi","title":"KubeJsonApi","text":"Re-exports KubeJsonApi
"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapidata","title":"KubeJsonApiData","text":"Re-exports KubeJsonApiData
"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapidatafor","title":"KubeJsonApiDataFor","text":"Re-exports KubeJsonApiDataFor
"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapiobjectmetadata","title":"KubeJsonApiObjectMetadata","text":"Re-exports KubeJsonApiObjectMetadata
"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobject","title":"KubeObject","text":"Re-exports KubeObject
"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectmetadata","title":"KubeObjectMetadata","text":"Re-exports KubeObjectMetadata
"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstore","title":"KubeObjectStore","text":"Re-exports KubeObjectStore
"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstoreloadallparams","title":"KubeObjectStoreLoadAllParams","text":"Re-exports KubeObjectStoreLoadAllParams
"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstoreloadingparams","title":"KubeObjectStoreLoadingParams","text":"Re-exports KubeObjectStoreLoadingParams
"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstoresubscribeparams","title":"KubeObjectStoreSubscribeParams","text":"Re-exports KubeObjectStoreSubscribeParams
"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubestatus","title":"KubeStatus","text":"Re-exports KubeStatus
"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubestatusdata","title":"KubeStatusData","text":"Re-exports KubeStatusData
"},{"location":"extensions/api/modules/Renderer.K8sApi/#limitrange","title":"LimitRange","text":"Re-exports LimitRange
"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespace","title":"Namespace","text":"Re-exports Namespace
"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespacescopedmetadata","title":"NamespaceScopedMetadata","text":"Re-exports NamespaceScopedMetadata
"},{"location":"extensions/api/modules/Renderer.K8sApi/#networkpolicy","title":"NetworkPolicy","text":"Re-exports NetworkPolicy
"},{"location":"extensions/api/modules/Renderer.K8sApi/#node","title":"Node","text":"Re-exports Node
"},{"location":"extensions/api/modules/Renderer.K8sApi/#nodesapi","title":"NodesApi","text":"Re-exports NodesApi
"},{"location":"extensions/api/modules/Renderer.K8sApi/#ownerreference","title":"OwnerReference","text":"Re-exports OwnerReference
"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolume","title":"PersistentVolume","text":"Re-exports PersistentVolume
"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeclaim","title":"PersistentVolumeClaim","text":"Re-exports PersistentVolumeClaim
"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeclaimsapi","title":"PersistentVolumeClaimsApi","text":"Re-exports PersistentVolumeClaimsApi
"},{"location":"extensions/api/modules/Renderer.K8sApi/#pod","title":"Pod","text":"Re-exports Pod
"},{"location":"extensions/api/modules/Renderer.K8sApi/#poddisruptionbudget","title":"PodDisruptionBudget","text":"Re-exports PodDisruptionBudget
"},{"location":"extensions/api/modules/Renderer.K8sApi/#podsapi","title":"PodsApi","text":"Re-exports PodsApi
"},{"location":"extensions/api/modules/Renderer.K8sApi/#priorityclass","title":"PriorityClass","text":"Re-exports PriorityClass
"},{"location":"extensions/api/modules/Renderer.K8sApi/#replicaset","title":"ReplicaSet","text":"Re-exports ReplicaSet
"},{"location":"extensions/api/modules/Renderer.K8sApi/#resourcequota","title":"ResourceQuota","text":"Re-exports ResourceQuota
"},{"location":"extensions/api/modules/Renderer.K8sApi/#resourcestack","title":"ResourceStack","text":"Re-exports ResourceStack
"},{"location":"extensions/api/modules/Renderer.K8sApi/#role","title":"Role","text":"Re-exports Role
"},{"location":"extensions/api/modules/Renderer.K8sApi/#rolebinding","title":"RoleBinding","text":"Re-exports RoleBinding
"},{"location":"extensions/api/modules/Renderer.K8sApi/#secret","title":"Secret","text":"Re-exports Secret
"},{"location":"extensions/api/modules/Renderer.K8sApi/#service","title":"Service","text":"Re-exports Service
"},{"location":"extensions/api/modules/Renderer.K8sApi/#serviceaccount","title":"ServiceAccount","text":"Re-exports ServiceAccount
"},{"location":"extensions/api/modules/Renderer.K8sApi/#statefulset","title":"StatefulSet","text":"Re-exports StatefulSet
"},{"location":"extensions/api/modules/Renderer.K8sApi/#storageclass","title":"StorageClass","text":"Re-exports StorageClass
"},{"location":"extensions/api/modules/Renderer.K8sApi/#apimanager","title":"apiManager","text":"Re-exports apiManager
"},{"location":"extensions/api/modules/Renderer.K8sApi/#createkubeobject","title":"createKubeObject","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Renderer.K8sApi/#createresourcestack","title":"createResourceStack","text":"Re-exports createResourceStack
"},{"location":"extensions/api/modules/Renderer.K8sApi/#forcluster","title":"forCluster","text":"Re-exports forCluster
"},{"location":"extensions/api/modules/Renderer.K8sApi/#forremotecluster","title":"forRemoteCluster","text":"Re-exports forRemoteCluster
"},{"location":"extensions/api/modules/Renderer.K8sApi/#getpodsbyownerid","title":"getPodsByOwnerId","text":"Re-exports getPodsByOwnerId
"},{"location":"extensions/api/modules/Renderer.K8sApi/#isjsonapidata","title":"isJsonApiData","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Renderer.K8sApi/#isjsonapidatalist","title":"isJsonApiDataList","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Renderer.K8sApi/#iskubejsonapilistmetadata","title":"isKubeJsonApiListMetadata","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Renderer.K8sApi/#iskubejsonapimetadata","title":"isKubeJsonApiMetadata","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Renderer.K8sApi/#iskubeobjectnonsystem","title":"isKubeObjectNonSystem","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Renderer.K8sApi/#iskubestatusdata","title":"isKubeStatusData","text":"Re-exports isKubeStatusData
"},{"location":"extensions/api/modules/Renderer.K8sApi/#ispartialjsonapidata","title":"isPartialJsonApiData","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Renderer.K8sApi/#ispartialjsonapimetadata","title":"isPartialJsonApiMetadata","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Renderer.K8sApi/#stringifylabels","title":"stringifyLabels","text":"Renames and re-exports __type
"},{"location":"extensions/api/modules/Renderer.K8sApi/#type-aliases_1","title":"Type Aliases","text":""},{"location":"extensions/api/modules/Renderer.K8sApi/#requestmetrics","title":"RequestMetrics","text":"\u01ac RequestMetrics: ReturnType<typeof requestMetricsInjectable[\"instantiate\"]>
\u2022 Const clusterRoleApi: ClusterRoleApi
\u2022 Const clusterRoleBindingApi: ClusterRoleBindingApi
\u2022 Const configMapApi: ConfigMapApi
\u2022 Const crdApi: CustomResourceDefinitionApi
\u2022 Const cronJobApi: CronJobApi
\u2022 Const daemonSetApi: DaemonSetApi
\u2022 Const deploymentApi: DeploymentApi
\u2022 Const endpointApi: EndpointsApi
\u2022 Const eventApi: KubeEventApi
\u2022 Const hpaApi: HorizontalPodAutoscalerApi
\u2022 Const ingressApi: IngressApi
\u2022 Const jobApi: JobApi
\u2022 Const limitRangeApi: LimitRangeApi
\u2022 Const namespacesApi: NamespaceApi
\u2022 Const networkPolicyApi: NetworkPolicyApi
\u2022 Const nodesApi: NodeApi
\u2022 Const pcApi: PriorityClassApi
\u2022 Const pdbApi: PodDisruptionBudgetApi
\u2022 Const persistentVolumeApi: PersistentVolumeApi
\u2022 Const podsApi: PodApi
\u2022 Const pvcApi: PersistentVolumeClaimApi
\u2022 Const replicaSetApi: ReplicaSetApi
\u2022 Const resourceQuotaApi: ResourceQuotaApi
\u2022 Const roleApi: RoleApi
\u2022 Const roleBindingApi: RoleBindingApi
\u2022 Const secretsApi: SecretApi
\u2022 Const serviceAccountsApi: ServiceAccountApi
\u2022 Const serviceApi: ServiceApi
\u2022 Const statefulSetApi: StatefulSetApi
\u2022 Const storageClassApi: StorageClassApi
\u2022 Const vpaApi: VerticalPodAutoscalerApi
\u25b8 isAllowedResource(resources): boolean
resources KubeResource | KubeResource[]"},{"location":"extensions/api/modules/Renderer.K8sApi/#returns","title":"Returns","text":"boolean
\u25b8 requestMetrics(query, params?): Promise<MetricData>
query string params? RequestMetricsParams"},{"location":"extensions/api/modules/Renderer.K8sApi/#returns_1","title":"Returns","text":"Promise<MetricData>
\u25b8 requestMetrics(query, params?): Promise<MetricData[]>
query string[] params? RequestMetricsParams"},{"location":"extensions/api/modules/Renderer.K8sApi/#returns_2","title":"Returns","text":"Promise<MetricData[]>
\u25b8 requestMetrics<Keys>(query, params?): Promise<Record<Keys, MetricData>>
Keys extends string"},{"location":"extensions/api/modules/Renderer.K8sApi/#parameters_3","title":"Parameters","text":"Name Type query Record<Keys, Partial<Record<string, string>>> params? RequestMetricsParams"},{"location":"extensions/api/modules/Renderer.K8sApi/#returns_3","title":"Returns","text":"Promise<Record<Keys, MetricData>>
@k8slens/extensions / Exports / Renderer / Navigation
"},{"location":"extensions/api/modules/Renderer.Navigation/#namespace-navigation","title":"Namespace: Navigation","text":"Renderer.Navigation
"},{"location":"extensions/api/modules/Renderer.Navigation/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer.Navigation/#classes","title":"Classes","text":"\u25b8 createPageParam<Value>(init): PageParam<Value>
Value string"},{"location":"extensions/api/modules/Renderer.Navigation/#parameters","title":"Parameters","text":"Name Type init PageParamInit<Value>"},{"location":"extensions/api/modules/Renderer.Navigation/#returns","title":"Returns","text":"PageParam<Value>
\u25b8 getDetailsUrl(selfLink, resetSelected?, mergeGlobals?): string
selfLink string resetSelected? boolean mergeGlobals? boolean"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_1","title":"Returns","text":"string
\u25b8 hideDetails(): void
void
\u25b8 hideEntityDetails(): void
void
\u25b8 isActiveRoute(route): boolean
route string | RouteProps<string, {}> | string[]"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_4","title":"Returns","text":"boolean
\u25b8 navigate(location): void
location LocationDescriptor<unknown>"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_5","title":"Returns","text":"void
\u25b8 showDetails(selfLink, resetSelected?): void
Default
resetSelected true\n"},{"location":"extensions/api/modules/Renderer.Navigation/#parameters_4","title":"Parameters","text":"Name Type Description selfLink undefined | string The Kube selflink to show details for resetSelected? boolean If true then will reset the selected kube object (which object is highlighted generally)"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_6","title":"Returns","text":"void
\u25b8 showEntityDetails(id): void
id string"},{"location":"extensions/api/modules/Renderer.Navigation/#returns_7","title":"Returns","text":"void
@k8slens/extensions / Exports / Renderer / Theme
"},{"location":"extensions/api/modules/Renderer.Theme/#namespace-theme","title":"Namespace: Theme","text":"Renderer.Theme
"},{"location":"extensions/api/modules/Renderer.Theme/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer.Theme/#interfaces","title":"Interfaces","text":"\u2022 Const activeTheme: IComputedValue
\u25b8 getActiveTheme(): ReadonlyObjectDeep
Deprecated
This hides the reactivity of active theme, use activeTheme instead
"},{"location":"extensions/api/modules/Renderer.Theme/#returns","title":"Returns","text":"ReadonlyObjectDeep
@k8slens/extensions / Exports / Renderer
"},{"location":"extensions/api/modules/Renderer/#namespace-renderer","title":"Namespace: Renderer","text":""},{"location":"extensions/api/modules/Renderer/#table-of-contents","title":"Table of contents","text":""},{"location":"extensions/api/modules/Renderer/#namespaces","title":"Namespaces","text":"Here we will discuss common and important building blocks for your extensions, and explain how you can use them. Almost all extensions use some of these functionalities.
"},{"location":"extensions/capabilities/common-capabilities/#main-extension","title":"Main Extension","text":"The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line.
"},{"location":"extensions/capabilities/common-capabilities/#activate","title":"Activate","text":"This extension can register a custom callback that is executed when an extension is activated (started).
import { Main } from \"@k8slens/extensions\"\n\nexport default class ExampleMainExtension extends Main.LensExtension {\nasync onActivate() {\nconsole.log(\"hello world\")\n}\n}\n"},{"location":"extensions/capabilities/common-capabilities/#deactivate","title":"Deactivate","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped).
import { Main } from \"@k8slens/extensions\"\n\nexport default class ExampleMainExtension extends Main.LensExtension {\nasync onDeactivate() {\nconsole.log(\"bye bye\")\n}\n}\n"},{"location":"extensions/capabilities/common-capabilities/#menus","title":"Menus","text":"This extension can register custom app and tray menus that will be displayed on OS native menus.
Example:
import { Main } from \"@k8slens/extensions\"\n\nexport default class ExampleMainExtension extends Main.LensExtension {\nappMenus = [\n{\nparentId: \"help\",\nlabel: \"Example item\",\nclick() {\nMain.Navigation.navigate(\"https://k8slens.dev\");\n}\n}\n]\n\ntrayMenus = [\n{\nlabel: \"My links\",\nsubmenu: [\n{\nlabel: \"Lens\",\nclick() {\nMain.Navigation.navigate(\"https://k8slens.dev\");\n}\n},\n{\ntype: \"separator\"\n},\n{\nlabel: \"Lens Github\",\nclick() {\nMain.Navigation.navigate(\"https://github.com/lensapp/lens\");\n}\n}\n]\n}\n]\n}\n"},{"location":"extensions/capabilities/common-capabilities/#renderer-extension","title":"Renderer Extension","text":"The renderer extension runs in a browser context, and is visible in Lens's main window. In order to see logs from this extension you need to check them via View > Toggle Developer Tools > Console.
"},{"location":"extensions/capabilities/common-capabilities/#activate_1","title":"Activate","text":"This extension can register a custom callback that is executed when an extension is activated (started).
import { Renderer } from \"@k8slens/extensions\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nasync onActivate() {\nconsole.log(\"hello world\")\n}\n}\n"},{"location":"extensions/capabilities/common-capabilities/#deactivate_1","title":"Deactivate","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped).
import { Renderer } from \"@k8slens/extensions\"\n\nexport default class ExampleMainExtension extends Renderer.LensExtension {\nasync onDeactivate() {\nconsole.log(\"bye bye\")\n}\n}\n"},{"location":"extensions/capabilities/common-capabilities/#global-pages","title":"Global Pages","text":"This extension can register custom global pages (views) to Lens's main window. The global page is a full-screen page that hides all other content from a window.
import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\"\nimport { ExamplePage } from \"./src/example-page\"\n\nconst {\nComponent: {\nIcon,\n}\n} = Renderer;\n\nexport default class ExampleRendererExtension extends Renderer.LensExtension {\nglobalPages = [\n{\nid: \"example\",\ncomponents: {\nPage: ExamplePage,\n}\n}\n]\n\nglobalPageMenus = [\n{\ntitle: \"Example page\", // used in icon's tooltip\ntarget: { pageId: \"example\" }\ncomponents: {\nIcon: () => <Icon material=\"arrow\"/>,\n}\n}\n]\n}\n"},{"location":"extensions/capabilities/common-capabilities/#app-preferences","title":"App Preferences","text":"This extension can register custom app preferences. It is responsible for storing a state for custom preferences.
import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\"\nimport { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\"\nimport { MyCustomPreferenceHint, MyCustomPreferenceInput } from \"./src/my-custom-preference\"\n\n\nexport default class ExampleRendererExtension extends Renderer.LensExtension {\nappPreferences = [\n{\ntitle: \"My Custom Preference\",\ncomponents: {\nHint: () => <MyCustomPreferenceHint/>,\nInput: () => <MyCustomPreferenceInput store={myCustomPreferencesStore}/>\n}\n}\n]\n}\n"},{"location":"extensions/capabilities/common-capabilities/#cluster-pages","title":"Cluster Pages","text":"This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened.
import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\";\nimport { ExampleIcon, ExamplePage } from \"./src/page\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nclusterPages = [\n{\nid: \"extension-example\", // optional\nexact: true, // optional\ncomponents: {\nPage: () => <ExamplePage extension={this}/>,\n}\n}\n]\n\nclusterPageMenus = [\n{\nurl: \"/extension-example\", // optional\ntitle: \"Example Extension\",\ncomponents: {\nIcon: ExampleIcon,\n}\n}\n]\n}\n"},{"location":"extensions/capabilities/common-capabilities/#top-bar-items","title":"Top Bar Items","text":"This extension can register custom components to a top bar area.
import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: {\nIcon,\n}\n} = Renderer;\n\nexport default class ExampleExtension extends Renderer.LensExtension {\ntopBarItems = [\n{\ncomponents: {\nItem: () => (\n<Icon material=\"favorite\" onClick={() => this.navigate(\"/example-page\" />\n)\n}\n}\n]\n}\n"},{"location":"extensions/capabilities/common-capabilities/#status-bar-items","title":"Status Bar Items","text":"This extension can register custom icons and text to a status bar area.
import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: {\nIcon,\n}\n} = Renderer;\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nstatusBarItems = [\n{\ncomponents: {\nItem: () => (\n<div className=\"flex align-center gaps hover-highlight\" onClick={() => this.navigate(\"/example-page\")} >\n<Icon material=\"favorite\" />\n</div>\n)\n}\n}\n]\n}\n"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-workloads-overview-items","title":"Kubernetes Workloads Overview Items","text":"This extension can register custom workloads overview items.
import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\";\nimport { CustomWorkloadsOverviewItem } from \"./src/custom-workloads-overview-item\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nkubeWorkloadsOverviewItems = [\n{\ncomponents: {\nDetails: () => <CustomWorkloadsOverviewItem />\n}\n}\n]\n}\n"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-menu-items","title":"Kubernetes Object Menu Items","text":"This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions.
import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\";\nimport { CustomMenuItem, CustomMenuItemProps } from \"./src/custom-menu-item\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nkubeObjectMenuItems = [\n{\nkind: \"Node\",\napiVersions: [\"v1\"],\ncomponents: {\nMenuItem: (props: CustomMenuItemProps) => <CustomMenuItem {...props} />\n}\n}\n]\n}\n"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-details","title":"Kubernetes Object Details","text":"This extension can register custom details (content) for specified Kubernetes kinds/apiVersions.
import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\";\nimport { CustomKindDetails, CustomKindDetailsProps } from \"./src/custom-kind-details\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nkubeObjectDetailItems = [\n{\nkind: \"CustomKind\",\napiVersions: [\"custom.acme.org/v1\"],\ncomponents: {\nDetails: (props: CustomKindDetailsProps) => <CustomKindDetails {...props} />\n}\n}\n]\n}\n"},{"location":"extensions/capabilities/styling/","title":"Styling an Extension","text":"Lens provides a set of global styles and UI components that can be used by any extension to preserve the look and feel of the application.
"},{"location":"extensions/capabilities/styling/#layout","title":"Layout","text":"For layout tasks, Lens uses the flex.box library which provides helpful class names to specify some of the flexbox properties. For example, consider the following HTML and its associated CSS properties:
<div className=\"flex column align-center\"></div>\n div {\ndisplay: flex;\nflex-direction: column;\nalign-items: center;\n}\n However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS.
"},{"location":"extensions/capabilities/styling/#layout-variables","title":"Layout Variables","text":"There is a set of CSS variables available for for basic layout needs. They are located inside :root and are defined in app.scss:
--unit: 8px;\n--padding: var(--unit);\n--margin: var(--unit);\n--border-radius: 3px;\n These variables are intended to set consistent margins and paddings across components. For example:
.status {\npadding-left: calc(var(--padding) * 2);\nborder-radius: var(--border-radius);\n}\n"},{"location":"extensions/capabilities/styling/#themes","title":"Themes","text":"Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark.
"},{"location":"extensions/capabilities/styling/#theme-variables","title":"Theme Variables","text":"When Lens is loaded, it transforms the selected theme's json file into a list of CSS Custom Properties (CSS Variables). This list then gets injected into the :root element so that any of the down-level components can use them.
When the user changes the theme, the above process is repeated, and new CSS variables appear, replacing the previous ones.
If you want to preserve Lens's native look and feel, with respect to the lightness or darkness of your extension, you can use the provided variables and built-in Lens components such as Button, Select, Table, and so on.
There is a set of CSS variables available for extensions to use for theming. They are all located inside :root and are defined in app.scss:
--font-main: 'Roboto', 'Helvetica', 'Arial', sans-serif;\n--font-monospace: Lucida Console, Monaco, Consolas, monospace;\n--font-size-small: calc(1.5 * var(--unit));\n--font-size: calc(1.75 * var(--unit));\n--font-size-big: calc(2 * var(--unit));\n--font-weight-thin: 300;\n--font-weight-normal: 400;\n--font-weight-bold: 500;\n as well as in the theme modules:
--blue: #3d90ce;\n--magenta: #c93dce;\n--golden: #ffc63d;\n--halfGray: #87909c80;\n--primary: #3d90ce;\n--textColorPrimary: #555555;\n--textColorSecondary: #51575d;\n--textColorAccent: #333333;\n--borderColor: #c9cfd3;\n--borderFaintColor: #dfdfdf;\n--mainBackground: #f1f1f1;\n--contentColor: #ffffff;\n--layoutBackground: #e8e8e8;\n--layoutTabsBackground: #f8f8f8;\n--layoutTabsActiveColor: #333333;\n--layoutTabsLineColor: #87909c80;\n...\n These variables can be used in the following form: var(--magenta). For example:
.status {\nfont-size: var(--font-size-small);\nbackground-color: var(--colorSuccess);\n}\n"},{"location":"extensions/capabilities/styling/#theme-switching","title":"Theme Switching","text":"When the light theme is active, the <body> element gets a \"theme-light\" class, or: <body class=\"theme-light\">. If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page:
There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose.
import React from \"react\"\nimport { observer } from \"mobx-react\"\nimport { Renderer } from \"@k8slens/extensions\";\n\n@observer\nexport class SupportPage extends React.Component {\nrender() {\nreturn (\n<div className=\"SupportPage\">\n<h1>Active theme is {Renderer.Theme.getActiveTheme().name}</h1>\n</div>\n);\n}\n}\n Theme entity from @k8slens/extensions provides active theme object and @observer decorator makes component reactive - so it will rerender each time any of the observables (active theme in our case) will be changed.
Working example provided in Styling with Emotion sample extension.
"},{"location":"extensions/capabilities/styling/#injected-styles","title":"Injected Styles","text":"Every extension is affected by the list of default global styles defined in app.scss. These are basic browser resets and element styles, including:
box-sizing property for every elementExtensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy.
"},{"location":"extensions/capabilities/styling/#css-in-js","title":"CSS-in-JS","text":"If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows:
const Container = styled.div(() => ({\nbackgroundColor: 'var(--mainBackground)'\n}));\n"},{"location":"extensions/capabilities/styling/#examples","title":"Examples","text":"You can explore samples for each styling technique that you can use for extensions:
In the previous section you learned how to create your first extension. In this section you will learn how this extension works under the hood.
The Hello World sample extension does three things:
onActivate() and outputs a message to the console.onDeactivate() and outputs a message to the console.ClusterPage so that the page is visible in the left-side menu of the cluster dashboard.Let's take a closer look at our Hello World sample's source code and see how these three things are achieved.
"},{"location":"extensions/get-started/anatomy/#extension-file-structure","title":"Extension File Structure","text":".\n\u251c\u2500\u2500 .gitignore // Ignore build output and node_modules\n\u251c\u2500\u2500 Makefile // Config for build tasks that compiles the extension\n\u251c\u2500\u2500 README.md // Readable description of your extension's functionality\n\u251c\u2500\u2500 src\n\u2502 \u2514\u2500\u2500 page.tsx // Extension's additional source code\n\u251c\u2500\u2500 main.ts // Source code for extension's main entrypoint\n\u251c\u2500\u2500 package.json // Extension manifest and dependencies\n\u251c\u2500\u2500 renderer.tsx // Source code for extension's renderer entrypoint\n\u251c\u2500\u2500 tsconfig.json // TypeScript configuration\n\u251c\u2500\u2500 webpack.config.js // Webpack configuration\n The extension directory contains the extension's entry files and a few configuration files. Three files: package.json, main.ts and renderer.tsx are essential to understanding the Hello World sample extension. We'll look at those first.
Each Lens extension must have a package.json file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as publisher and contributes. Some of the most-important fields include:
name and publisher: Lens uses @<publisher>/<name> as a unique ID for the extension. For example, the Hello World sample has the ID @lensapp-samples/helloworld-sample. Lens uses this ID to uniquely identify your extension.main: the extension's entry point run in main process.renderer: the extension's entry point run in renderer process.engines.lens: the minimum version of Lens API that the extension depends upon. We only support the ^ range, which is also optional to specify, and only major and minor version numbers. Meaning that ^5.4 and 5.4 both mean the same thing, and the patch version in 5.4.2 is ignored.{\n\"name\": \"helloworld-sample\",\n\"publisher\": \"lens-samples\",\n\"version\": \"0.0.1\",\n\"description\": \"Lens helloworld-sample\",\n\"license\": \"MIT\",\n\"homepage\": \"https://github.com/lensapp/lens-extension-samples\",\n\"engines\": {\n\"node\": \"^16.14.2\",\n\"lens\": \"5.4\"\n},\n\"main\": \"dist/main.js\",\n\"renderer\": \"dist/renderer.js\",\n\"scripts\": {\n\"build\": \"webpack --config webpack.config.js\",\n\"dev\": \"npm run build --watch\"\n},\n\"dependencies\": {\n\"react-open-doodles\": \"^1.0.5\"\n},\n\"devDependencies\": {\n\"@k8slens/extensions\": \"^5.4.6\",\n\"ts-loader\": \"^8.0.4\",\n\"typescript\": \"^4.5.5\",\n\"@types/react\": \"^17.0.44\",\n\"@types/node\": \"^16.14.2\",\n\"webpack\": \"^4.44.2\",\n\"webpack-cli\": \"^3.3.11\"\n}\n}\n"},{"location":"extensions/get-started/anatomy/#webpack-configuration","title":"Webpack configuration","text":"The following webpack externals are provided by Lens and must be used (when available) to make sure that the versions used are in sync.
mobx var global.Mobx >5.0.0 \u2705 \u2705 mobx-react var global.MobxReact >5.0.0 \u274c \u2705 react var global.React >5.0.0 \u274c \u2705 react-router var global.ReactRouter >5.0.0 \u274c \u2705 react-router-dom var global.ReactRouterDom >5.0.0 \u274c \u2705 react-dom var global.ReactDOM >5.5.0 \u274c \u2705 What is exported is the whole of the packages as a * import (within typescript).
For example, the following is how you would specify these within your webpack configuration files.
{\n...\n\"externals\": [\n...\n{\n\"mobx\": \"var global.Mobx\"\n\"mobx-react\": \"var global.MobxReact\"\n\"react\": \"var global.React\"\n\"react-router\": \"var global.ReactRouter\"\n\"react-router-dom\": \"var global.ReactRouterDom\"\n\"react-dom\": \"var global.ReactDOM\"\n}\n]\n}\n"},{"location":"extensions/get-started/anatomy/#extension-entry-files","title":"Extension Entry Files","text":"Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension, and the renderer entry file exports the class that extends LensRendererExtension.
Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur.
The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the \"Hello World\" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file.
import { Renderer } from \"@k8slens/extensions\";\nimport { ExampleIcon, ExamplePage } from \"./page\";\nimport React from \"react\";\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nclusterPages = [\n{\nid: \"extension-example\",\ncomponents: {\nPage: () => <ExamplePage extension={this} />,\n},\n},\n];\n}\n The Hello World sample extension uses the Cluster Page capability, which is just one of the Lens extension API's capabilities. The Common Capabilities page will help you home in on the right capabilities to use with your own extensions.
This is a general overview to how the development of an extension will proceed. For building extensions there will be a few things that you should have installed, and some other things that might be of help.
"},{"location":"extensions/get-started/overview/#required","title":"Required:","text":"All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors.
Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work.
Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is responsible for the lifetime of any resources it spins up. If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded.
See Your First Extension to get started.
"},{"location":"extensions/get-started/wrapping-up/","title":"Wrapping Up","text":"In Your First Extension, you learned how to create and run an extension. In Extension Anatomy, you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more.
"},{"location":"extensions/get-started/wrapping-up/#extension-capabilities","title":"Extension Capabilities","text":"In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the Common Capabilities page.
"},{"location":"extensions/get-started/wrapping-up/#guides-and-samples","title":"Guides and Samples","text":"Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the lens-extension-samples repository.
"},{"location":"extensions/get-started/wrapping-up/#testing-and-publishing","title":"Testing and Publishing","text":"In this section, you can learn:
We recommend to always use Yeoman generator for Lens Extension to start new extension project. Read the generator guide here.
If you want to setup the project manually, please continue reading.
"},{"location":"extensions/get-started/your-first-extension/#first-extension","title":"First Extension","text":"In this topic, you'll learn the basics of building extensions by creating an extension that adds a \"Hello World\" page to a cluster menu.
"},{"location":"extensions/get-started/your-first-extension/#install-the-extension","title":"Install the Extension","text":"To install the extension, clone the Lens Extension samples repository to your local machine:
git clone https://github.com/lensapp/lens-extension-samples.git\n Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is helloworld-sample.
mkdir -p ~/.k8slens/extensions\ncd ~/.k8slens/extensions\nln -s lens-extension-samples/helloworld-sample helloworld-sample\n"},{"location":"extensions/get-started/your-first-extension/#windows","title":"Windows","text":"Create the directory that Lens will monitor for user-installed extensions:
mkdir C:\\Users\\<user>\\.k8slens\\extensions -force\ncd C:\\Users\\<user>\\.k8slens\\extensions\n If you have administrator rights, you can create symlink to the sample extension \u2013 in this case helloworld-sample:
cmd /c mklink /D helloworld-sample lens-extension-samples\\helloworld-sample\n Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\<user>\\.k8slens\\extensions:
Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\<user>\\.k8slens\\extensions\\helloworld-sample'\n"},{"location":"extensions/get-started/your-first-extension/#build-the-extension","title":"Build the Extension","text":"To build the extension you can use make or run the npm commands manually:
cd <lens-extension-samples directory>/helloworld-sample\nmake build\n To run the npm commands, enter:
cd <lens-extension-samples directory>/helloworld-sample\nnpm install\nnpm run build\n Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter:
cd <lens-extension-samples directory>/helloworld-sample\nnpm run dev\n You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds.
With Lens running, either connect to an existing cluster or create a new one - refer to the latest Lens Documentation for details on how to add a cluster in Lens IDE. You will see the \"Hello World\" page in the left-side cluster menu.
"},{"location":"extensions/get-started/your-first-extension/#develop-the-extension","title":"Develop the Extension","text":"Finally, you'll make a change to the message that our Hello World sample extension displays:
<lens-extension-samples directory>/helloworld-sample.page.tsx, change the message from HelloWorld! to Hello Lens Extensions.npm run dev, the extension will rebuild automatically.In the next topic, we'll take a closer look at the source code of our Hello World sample.
You can find the source code for this tutorial at: lensapp/lens-extension-samples. Extension Guides contains additional samples.
"},{"location":"extensions/guides/","title":"Extension Guides","text":"This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see Your First Extension.
Each guide or code sample includes the following:
This guide is a brief overview about how the catalog works within Lens. The catalog should be thought of as the single source of truth about data within Lens.
The data flow is unidirectional, it only flows from the main side to the renderer side. All data is public within the catalog.
"},{"location":"extensions/guides/catalog/#categories","title":"Categories","text":"A category is the declaration to the catalog of a specific kind of entity. It declares the currently supported versions of that kind of entity but providing the constructors for the entity classes.
To declare a new category class you must create a new class that extends Common.Catalog.CatalogCategory and implement all of the abstract fields.
The categories provided by Lens itself have the following names:
KubernetesClustersWebLinksGeneralTo register a category, call the Main.Catalog.catalogCategories.add() and Renderer.Catalog.catalogCategories.add() with instances of your class.
By default when a specific category is selected in the catalog page a list of entities of the group and kind that the category has registered. It is possible to register custom views for specific categories by registering them on your Renderer.LensExtension class.
A registration takes the form of a Common.Types.CustomCategoryViewRegistration
For example:
import { Renderer, Common } from \"@k8slens/extensions\";\n\nfunction MyKubernetesClusterView({\ncategory,\n}: Common.Types.CustomCategoryViewProps) {\nreturn <div>My view: {category.getId()}</div>;\n}\n\nexport default class extends Renderer.LensExtension {\ncustomCategoryViews = [\n{\ngroup: \"entity.k8slens.dev\",\nkind: \"KubernetesCluster\",\npriority: 10,\ncomponents: {\nView: MyKubernetesClusterView,\n},\n},\n];\n}\n Will register a new view for the KubernetesCluster category, and because the priority is < 50 it will be displayed above the default list view.
The default list view has a priority of 50 and and custom views with priority (defaulting to 50) >= 50 will be displayed afterwards.
"},{"location":"extensions/guides/catalog/#styling-custom-views","title":"Styling Custom Views","text":"By default, custom view blocks are styled with Flexbox. Some details comes from this.
max-height css rule.height.An entity is the data within the catalog. All entities are typed and the class instances will be recreated on the renderer side by the catalog and the category registrations.
"},{"location":"extensions/guides/components/","title":"Components","text":""},{"location":"extensions/guides/components/#wip","title":"WIP","text":""},{"location":"extensions/guides/extending-kubernetes-cluster/","title":"Extending KubernetesCluster","text":"Extension can specify it's own subclass of Common.Catalog.KubernetesCluster. Extension can also specify a new Category for it in the Catalog.
"},{"location":"extensions/guides/extending-kubernetes-cluster/#extending-commoncatalogkubernetescluster","title":"Extending Common.Catalog.KubernetesCluster","text":"import { Common } from \"@k8slens/extensions\";\n\n// The kind must be different from KubernetesCluster's kind\nexport const kind = \"ManagedDevCluster\";\n\nexport class ManagedDevCluster extends Common.Catalog.KubernetesCluster {\npublic static readonly kind = kind;\n\npublic readonly kind = kind;\n}\n"},{"location":"extensions/guides/extending-kubernetes-cluster/#extending-commoncatalogcatalogcategory","title":"Extending Common.Catalog.CatalogCategory","text":"These custom Catalog entities can be added a new Category in the Catalog.
import { Common } from \"@k8slens/extensions\";\nimport { kind, ManagedDevCluster } from \"../entities/ManagedDevCluster\";\n\nclass ManagedDevClusterCategory extends Common.Catalog.CatalogCategory {\npublic readonly apiVersion = \"catalog.k8slens.dev/v1alpha1\";\npublic readonly kind = \"CatalogCategory\";\npublic metadata = {\nname: \"Managed Dev Clusters\",\nicon: \"\"\n};\npublic spec: Common.Catalog.CatalogCategorySpec = {\ngroup: \"entity.k8slens.dev\",\nversions: [\n{\nname: \"v1alpha1\",\nentityClass: ManagedDevCluster as any,\n},\n],\nnames: {\nkind\n},\n};\n}\n\nexport { ManagedDevClusterCategory };\nexport type { ManagedDevClusterCategory as ManagedDevClusterCategoryType };\n The category needs to be registered in the onActivate() method both in main and renderer
// in main's on onActivate\nMain.Catalog.catalogCategories.add(new ManagedDevClusterCategory());\n // in renderer's on onActivate\nRenderer.Catalog.catalogCategories.add(new ManagedDevClusterCategory());\n You can then add the entities to the Catalog as a new source:
this.addCatalogSource(\"managedDevClusters\", this.managedDevClusters);\n"},{"location":"extensions/guides/generator/","title":"Lens Extension Generator","text":"The Lens Extension Generator creates a directory with the necessary files for developing an extension.
"},{"location":"extensions/guides/generator/#installing-and-getting-started-with-the-generator","title":"Installing and Getting Started with the Generator","text":"To begin, install Yeoman and the Lens Extension Generator with the following command:
npm install -g yo generator-lens-ext\n Run the generator by entering the following command: yo lens-ext.
Answer the following questions:
# ? What type of extension do you want to create? New Extension (TypeScript)\n# ? What's the name of your extension? my-first-lens-ext\n# ? What's the description of your extension? My hello world extension\n# ? What's your extension's publisher name? @my-org/my-first-lens-ext\n# ? Initialize a git repository? Yes\n# ? Install dependencies after initialization? Yes\n# ? Which package manager to use? yarn\n# ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :Users\\<user>\\.k8slens\\extensions (windows)? Yes\n Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering:
cd my-first-lens-ext\nnpm start # start the webpack server in watch mode\n Open Lens and you will see a Hello World item in the left-side menu under Custom Resources:
"},{"location":"extensions/guides/generator/#developing-the-extension","title":"Developing the Extension","text":"Next, you'll try changing the way the new menu item appears in the UI. You'll change it from \"Hello World\" to \"Hello Lens\".
Open my-first-lens-ext/renderer.tsx and change the value of title from \"Hello World\" to \"Hello Lens\":
clusterPageMenus = [\n{\ntarget: { pageId: \"hello\" },\ntitle: \"Hello Lens\",\ncomponents: {\nIcon: ExampleIcon,\n},\n},\n];\n Reload Lens and you will see that the menu item text has changed to \"Hello Lens\". To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux.
To debug your extension, please see our instructions on Testing Extensions.
"},{"location":"extensions/guides/generator/#next-steps","title":"Next Steps","text":"To dive deeper, consider looking at Common Capabilities, Styling, or Extension Anatomy.
If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an issue. You can find the latest Lens contribution guidelines here.
The Generator source code is hosted at GitHub.
"},{"location":"extensions/guides/ipc/","title":"Inter Process Communication","text":"A Lens Extension can utilize IPC to send information between the renderer and main processes. This is useful when wanting to communicate directly within your extension.
For example, if a user logs into a service that your extension is a facade for and main needs to know some information so that you can start syncing items to the Catalog, this would be a good way to send that information along.
IPC channels are sectioned off per extension. Meaning that each extension can only communicate with itself.
"},{"location":"extensions/guides/ipc/#types-of-communication","title":"Types of Communication","text":"There are two flavours of communication that are provided:
This is the same as an Event Emitter but is not limited to just one Javascript process. This is a good option when you need to report that something has happened but you don't need a response.
This is a fully two-way form of communication. Both main and renderer can do this sort of IPC.
This is more like a Remote Procedure Call (RPC) or Send-Receive-Reply (SRR). With this sort of communication the caller needs to wait for the result from the other side. This is accomplished by await-ing the returned Promise<any>.
This is a unidirectional form of communication. Only renderer can initiate this kind of request, and only main can receive and respond to this kind of request.
The general terminology is as follows:
To register either a handler or a listener, you should do something like the following:
main.ts:
import { Main } from \"@k8slens/extensions\";\nimport { IpcMain } from \"./helpers/main\";\n\nexport class ExampleExtensionMain extends Main.LensExtension {\nonActivate() {\nIpcMain.createInstance(this);\n}\n}\n This file shows that you need to create an instance of the store to be able to use IPC. Lens will automatically clean up that store and all the handlers on deactivation and uninstall.
helpers/main.ts:
import { Main } from \"@k8slens/extensions\";\n\nexport class IpcMain extends Main.Ipc {\nconstructor(extension: Main.LensExtension) {\nsuper(extension);\n\nthis.listen(\"initialize\", onInitialize);\n}\n}\n\nfunction onInitialize(event: Types.IpcMainEvent, id: string) {\nconsole.log(`starting to initialize: ${id}`);\n}\n In other files, it is not necessary to pass around any instances. You should be able to just call IpcMain.getInstance() anywhere it is needed in your extension.
renderer.ts:
import { Renderer } from \"@k8slens/extensions\";\nimport { IpcRenderer } from \"./helpers/renderer\";\n\nexport class ExampleExtensionRenderer extends Renderer.LensExtension {\nonActivate() {\nconst ipc = IpcRenderer.createInstance(this);\n\nsetTimeout(() => ipc.broadcast(\"initialize\", \"an-id\"), 5000);\n}\n}\n It is also needed to create an instance to broadcast messages too.
helpers/renderer.ts:
import { Renderer } from \"@k8slens/extensions\";\n\nexport class IpcRenderer extends Renderer.Ipc {}\n It is necessary to create child classes of these abstract class's in your extension before you can use them.
As this example shows: the channel names must be the same. It should also be noted that \"listeners\" and \"handlers\" are specific to either renderer or main. There is no behind the scenes transfer of these functions.
To register a \"handler\" call IpcMain.getInstance().handle(...). The cleanup of these handlers is handled by Lens itself.
The listen() methods on Main.Ipc and Renderer.Ipc return a Disposer, or more specifically, a () => void. This can be optionally called to remove the listener early.
Calling either IpcRenderer.getInstance().broadcast(...) or IpcMain.getInstance().broadcast(...) sends an event to all renderer frames and to main. Because of this, no matter where you broadcast from, all listeners in main and renderer will be notified.
This IPC mechanism utilizes the Structured Clone Algorithm for serialization. This means that more types than what are JSON serializable can be used, but not all the information will be passed through.
"},{"location":"extensions/guides/ipc/#using-request-based-communication","title":"Using Request Based Communication","text":"If you are meaning to do a request based call from renderer, you should do const res = await IpcRenderer.getInstance().invoke(<channel>, ...<args>)); instead.
In this guide we will learn how to list Kubernetes CRD objects on the cluster dashboard. You can see the complete source code for this guide here.
Next, we will go the implementation through in steps. To achieve our goal, we need to:
clusterPage and clusterPageMenu Objects","text":"First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class:
export default class CrdSampleExtension extends Renderer.LensExtension {\n}\n To register menu item in the cluster menu we need to register PageMenuRegistration object. This object will register a menu item with \"Certificates\" text. It will also use CertificateIcon component to render an icon and navigate to cluster page that is having certificates page id.
import { Renderer } from \"@k8slens/extensions\";\n\ntype IconProps = Renderer.Component.IconProps;\n\nconst {\nComponent: {\nIcon,\n},\n} = Renderer;\n\nexport function CertificateIcon(props: IconProps) {\nreturn <Icon {...props} material=\"security\" tooltip=\"Certificates\"/>\n}\n\nexport default class CrdSampleExtension extends Renderer.LensExtension {\n\nclusterPageMenus = [\n{\ntarget: { pageId: \"certificates\" },\ntitle: \"Certificates\",\ncomponents: {\nIcon: CertificateIcon,\n}\n},\n]\n}\n Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates.
export default class CrdSampleExtension extends Renderer.LensExtension {\n...\n\nclusterPages = [{\nid: \"certificates\",\ncomponents: {\nPage: () => <CertificatePage extension={this} />,\nMenuIcon: CertificateIcon,\n}\n}]\n}\n"},{"location":"extensions/guides/kube-object-list-layout/#list-certificate-objects-on-the-cluster-page","title":"List Certificate Objects on the Cluster Page","text":"In the previous step we defined CertificatePage component to render certificates. In this step we will actually implement that. CertificatePage is a React component that will render Renderer.Component.KubeObjectListLayout component to list Certificate CRD objects.
In order to list CRD objects, we need first fetch those from Kubernetes API. Lens Extensions API provides easy mechanism to do this. We just need to define Certificate class derived from Renderer.K8sApi.KubeObject, CertificatesApiderived from Renderer.K8sApi.KubeApi and CertificatesStore derived from Renderer.K8sApi.KubeObjectStore.
Certificate class defines properties found in the CRD object:
import { Renderer } from \"@k8slens/extensions\";\n\nconst {\nK8sApi: {\nKubeObject,\nKubeObjectStore,\nKubeApi,\napiManager,\n},\n} = Renderer;\n\nexport class Certificate extends KubeObject {\nstatic kind = \"Certificate\"\nstatic namespaced = true\nstatic apiBase = \"/apis/cert-manager.io/v1alpha2/certificates\"\n\nkind: string\napiVersion: string\nmetadata: {\nname: string;\nnamespace: string;\nselfLink: string;\nuid: string;\nresourceVersion: string;\ncreationTimestamp: string;\nlabels: {\n[key: string]: string;\n};\nannotations: {\n[key: string]: string;\n};\n}\nspec: {\ndnsNames: string[];\nissuerRef: {\ngroup: string;\nkind: string;\nname: string;\n}\nsecretName: string\n}\nstatus: {\nconditions: {\nlastTransitionTime: string;\nmessage: string;\nreason: string;\nstatus: string;\ntype?: string;\n}[];\n}\n}\n With CertificatesApi class we are able to manage Certificate objects in Kubernetes API:
export class CertificatesApi extends KubeApi<Certificate> {}\n\nexport const certificatesApi = new CertificatesApi({\nobjectConstructor: Certificate\n});\n CertificateStore defines storage for Certificate objects
export class CertificatesStore extends KubeObjectStore<Certificate> {\napi = certificatesApi\n}\n\nexport const certificatesStore = new CertificatesStore();\n And, finally, we register this store to Lens's API manager.
apiManager.registerStore(certificatesStore);\n"},{"location":"extensions/guides/kube-object-list-layout/#create-certificatepage-component","title":"Create CertificatePage component","text":"Now we have created mechanism to manage Certificate objects in Kubernetes API. Then we need to fetch those and render them in the UI.
First we define CertificatePage class that extends React.Component.
import { Renderer } from \"@k8slens/extensions\";\nimport React from \"react\";\nimport { certificatesStore } from \"../certificate-store\";\nimport { Certificate } from \"../certificate\"\n\nexport class CertificatePage extends React.Component<{ extension: Renderer.LensExtension }> {\n\n}\n Next we will implement render method that will display certificates in a list. To do that, we just need to add Renderer.Component.KubeObjectListLayout component inside Renderer.Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Renderer.Component.KubeObjectListLayout in store property. Renderer.Component.KubeObjectListLayout will fetch automatically items from the given store when component is mounted. Also, we can define needed sorting callbacks and search filters for the list:
import { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: {\nTabLayout,\nKubeObjectListLayout,\n},\n} = Renderer;\n\nenum sortBy {\nname = \"name\",\nnamespace = \"namespace\",\nissuer = \"issuer\"\n}\n\nexport class CertificatePage extends React.Component<{ extension: LensRendererExtension }> {\n// ...\n\nrender() {\nreturn (\n<TabLayout>\n<KubeObjectListLayout\nclassName=\"Certificates\" store={certificatesStore}\nsortingCallbacks={{\n[sortBy.name]: (certificate: Certificate) => certificate.getName(),\n[sortBy.namespace]: (certificate: Certificate) => certificate.metadata.namespace,\n[sortBy.issuer]: (certificate: Certificate) => certificate.spec.issuerRef.name\n}}\nsearchFilters={[\n(certificate: Certificate) => certificate.getSearchFields()\n]}\nrenderHeaderTitle=\"Certificates\"\nrenderTableHeader={[\n{ title: \"Name\", className: \"name\", sortBy: sortBy.name },\n{ title: \"Namespace\", className: \"namespace\", sortBy: sortBy.namespace },\n{ title: \"Issuer\", className: \"issuer\", sortBy: sortBy.namespace },\n]}\nrenderTableContents={(certificate: Certificate) => [\ncertificate.getName(),\ncertificate.metadata.namespace,\ncertificate.spec.issuerRef.name\n]}\n/>\n</TabLayout>\n)\n}\n}\n"},{"location":"extensions/guides/kube-object-list-layout/#customize-details-panel","title":"Customize Details panel","text":"We have learned now, how to list CRD objects in a list view. Next, we will learn how to customize details panel that will be opened when the object is clicked in the list.
First, we need to register our custom component to render details for the specific Kubernetes custom resource, in our case Certificate. We will do this again in CrdSampleExtension class:
export default class CrdSampleExtension extends Renderer.LensExtension {\n//...\n\nkubeObjectDetailItems = [{\nkind: Certificate.kind,\napiVersions: [\"cert-manager.io/v1alpha2\"],\ncomponents: {\nDetails: (props: CertificateDetailsProps) => <CertificateDetails {...props} />\n}\n}]\n}\n Here we defined that CertificateDetails component will render the resource details. So, next we need to implement that component. Lens will inject Certificate object into our component so we just need to render some information out of it. We can use Renderer.Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere:
import { Renderer } from \"@k8slens/extensions\";\nimport React from \"react\";\nimport { Certificate } from \"../certificate\";\n\nconst {\nComponent: {\nKubeObjectDetailsProps,\nDrawerItem,\nBadge,\n}\n} = Renderer;\n\nexport interface CertificateDetailsProps extends KubeObjectDetailsProps<Certificate>{\n}\n\nexport class CertificateDetails extends React.Component<CertificateDetailsProps> {\n\nrender() {\nconst { object: certificate } = this.props;\nif (!certificate) return null;\nreturn (\n<div className=\"Certificate\">\n<DrawerItem name=\"Created\">\n{certificate.getAge(true, false)} ago ({certificate.metadata.creationTimestamp })\n</DrawerItem>\n<DrawerItem name=\"DNS Names\">\n{certificate.spec.dnsNames.join(\",\")}\n</DrawerItem>\n<DrawerItem name=\"Secret\">\n{certificate.spec.secretName}\n</DrawerItem>\n<DrawerItem name=\"Status\" className=\"status\" labelsOnly>\n{certificate.status.conditions.map((condition, index) => {\nconst { type, reason, message, status } = condition;\nconst kind = type || reason;\nif (!kind) return null;\nreturn (\n<Badge\nkey={kind + index} label={kind}\nclassName={\"success \"+kind.toLowerCase()}\ntooltip={message}\n/>\n);\n})}\n</DrawerItem>\n</div>\n)\n}\n}\n"},{"location":"extensions/guides/kube-object-list-layout/#summary","title":"Summary","text":"Like we can see above, it's very easy to add custom pages and fetch Kubernetes resources by using Extensions API. Please see the complete source code to test it out.
"},{"location":"extensions/guides/main-extension/","title":"Main Extension","text":"The Main Extension API is the interface to Lens's main process. Lens runs in both main and renderer processes. The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items and protocol handlers, and run custom code in Lens's main process. It also provides convenient methods for navigating to built-in Lens pages and extension pages, as well as adding and removing sources of catalog entities.
"},{"location":"extensions/guides/main-extension/#mainlensextension-class","title":"Main.LensExtension Class","text":""},{"location":"extensions/guides/main-extension/#onactivate-and-ondeactivate-methods","title":"onActivate() and onDeactivate() Methods","text":"To create a main extension simply extend the Main.LensExtension class:
import { Main } from \"@k8slens/extensions\";\n\nexport default class ExampleExtensionMain extends Main.LensExtension {\nonActivate() {\nconsole.log(\"custom main process extension code started\");\n}\n\nonDeactivate() {\nconsole.log(\"custom main process extension de-activated\");\n}\n}\n Two methods enable you to run custom code: onActivate() and onDeactivate(). Enabling your extension calls onActivate() and disabling your extension calls onDeactivate(). You can initiate custom code by implementing onActivate(). Implementing onDeactivate() gives you the opportunity to clean up after your extension.
Disable extensions from the Lens Extensions page:
The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt.
For more details on accessing Lens state data, please see the Stores guide.
"},{"location":"extensions/guides/main-extension/#appmenus","title":"appMenus","text":"The Main Extension API allows you to customize the UI application menu. The following example demonstrates adding an item to the Help menu.
import { Main } from \"@k8slens/extensions\";\n\nexport default class SamplePageMainExtension extends Main.LensExtension {\nappMenus = [\n{\nparentId: \"help\",\nlabel: \"Sample\",\nclick() {\nconsole.log(\"Sample clicked\");\n},\n},\n];\n}\n appMenus is an array of objects that satisfy the MenuRegistration interface. MenuRegistration extends Electron's MenuItemConstructorOptions interface. The properties of the appMenus array objects are defined as follows:
parentId is the name of the menu where your new menu item will be listed. Valid values include: \"file\", \"edit\", \"view\", and \"help\". \"lens\" is valid on Mac only.label is the name of your menu item.click() is called when the menu item is selected. In this example, we simply log a message. However, you would typically have this navigate to a specific page or perform another operation. Note that pages are associated with the Renderer.LensExtension class and can be defined in the process of extending it.The following example demonstrates how an application menu can be used to navigate to such a page:
import { Main } from \"@k8slens/extensions\";\n\nexport default class SamplePageMainExtension extends Main.LensExtension {\nappMenus = [\n{\nparentId: \"help\",\nlabel: \"Sample\",\nclick: () => this.navigate(\"myGlobalPage\"),\n},\n];\n}\n When the menu item is clicked the navigate() method looks for and displays a global page with id \"myGlobalPage\". This page would be defined in your extension's Renderer.LensExtension implementation (See Renderer.LensExtension).
trayMenus","text":"trayMenus is an array of TrayMenuRegistration objects. Most importantly you can define a label and a click handler. Other properties are submenu, enabled, toolTip, id and type.
interface TrayMenuRegistration {\nlabel?: string;\nclick?: (menuItem: TrayMenuRegistration) => void;\nid?: string;\ntype?: \"normal\" | \"separator\" | \"submenu\";\ntoolTip?: string;\nenabled?: boolean;\nsubmenu?: TrayMenuRegistration[];\n}\n The following example demonstrates how tray menus can be added from extension:
import { Main } from \"@k8slens/extensions\";\n\nexport default class SampleTrayMenuMainExtension extends Main.LensExtension {\ntrayMenus = [\n{\nlabel: \"menu from the extension\",\nclick: () => {\nconsole.log(\"tray menu clicked!\");\n},\n},\n];\n}\n"},{"location":"extensions/guides/main-extension/#addcatalogsource-and-removecatalogsource-methods","title":"addCatalogSource() and removeCatalogSource() Methods","text":"The Main.LensExtension class also provides the addCatalogSource() and removeCatalogSource() methods, for managing custom catalog items (or entities). See the Catalog documentation for full details about the catalog.
Lens has a file association with the lens:// protocol. This means that Lens can be opened by external programs by providing a link that has lens as its protocol. Lens provides a routing mechanism that extensions can use to register custom handlers.
The field protocolHandlers exists both on LensMainExtension and on LensRendererExtension. This field will be iterated through every time a lens:// request gets sent to the application. The pathSchema argument must comply with the path-to-regexp package's compileToRegex function.
Once you have registered a handler it will be called when a user opens a link on their computer. Handlers will be run in both main and renderer in parallel with no synchronization between the two processes. Furthermore, both main and renderer are routed separately. In other words, which handler is selected in either process is independent from the list of possible handlers in the other.
Example of registering a handler:
import { Main, Common } from \"@k8slens/extensions\";\n\nfunction rootHandler(params: Common.Types.ProtocolRouteParams) {\nconsole.log(\"routed to ExampleExtension\", params);\n}\n\nexport default class ExampleExtensionMain extends Main.LensExtension {\nprotocolHandlers = [\npathSchema: \"/\",\nhandler: rootHandler,\n]\n}\n For testing the routing of URIs the open (on macOS) or xdg-open (on most linux) CLI utilities can be used. For the above handler, the following URI would be always routed to it:
open lens://extension/example-extension/\n"},{"location":"extensions/guides/protocol-handlers/#deregistering-a-protocol-handler","title":"Deregistering A Protocol Handler","text":"All that is needed to deregister a handler is to remove it from the array of handlers.
"},{"location":"extensions/guides/protocol-handlers/#routing-algorithm","title":"Routing Algorithm","text":"The routing mechanism for extensions is quite straight forward. For example consider an extension example-extension which is published by the @mirantis org. If it were to register a handler with \"/display/:type\" as its corresponding link then we would match the following URI like this:
Once matched, the handler would be called with the following argument (note both \"search\" and \"pathname\" will always be defined):
{\n\"search\": {\n\"text\": \"Hello\"\n},\n\"pathname\": {\n\"type\": \"notification\"\n}\n}\n As the diagram above shows, the search (or query) params are not considered as part of the handler resolution. If the URI had instead been lens://extension/@mirantis/example-extension/display/notification/green then a third (and optional) field will have the rest of the path. The tail field would be filled with \"/green\". If multiple pathSchema's match a given URI then the most specific handler will be called.
For example consider the following pathSchema's:
\"/\"\"/display\"\"/display/:type\"\"/show/:id\"The URI sub-path \"/display\" would be routed to #2 since it is an exact match. On the other hand, the subpath \"/display/notification\" would be routed to #3.
The URI is routed to the most specific matching pathSchema. This way the \"/\" (root) pathSchema acts as a sort of catch all or default route if no other route matches.
The Renderer Extension API is the interface to Lens's renderer process. Lens runs in both the main and renderer processes. The Renderer Extension API allows you to access, configure, and customize Lens data, add custom Lens UI elements, protocol handlers, and command palette commands, as well as run custom code in Lens's renderer process.
The custom Lens UI elements that you can add include:
as well as catalog-related UI elements:
All UI elements are based on React components.
Finally, you can also add commands and protocol handlers:
Renderer.LensExtension Class","text":""},{"location":"extensions/guides/renderer-extension/#onactivate-and-ondeactivate-methods","title":"onActivate() and onDeactivate() Methods","text":"To create a renderer extension, extend the Renderer.LensExtension class:
import { Renderer } from \"@k8slens/extensions\";\n\nexport default class ExampleExtensionMain extends Renderer.LensExtension {\nonActivate() {\nconsole.log(\"custom renderer process extension code started\");\n}\n\nonDeactivate() {\nconsole.log(\"custom renderer process extension de-activated\");\n}\n}\n Two methods enable you to run custom code: onActivate() and onDeactivate(). Enabling your extension calls onActivate() and disabling your extension calls onDeactivate(). You can initiate custom code by implementing onActivate(). Implementing onDeactivate() gives you the opportunity to clean up after your extension.
Info
Disable extensions from the Lens Extensions page:
1. Navigate to **File** > **Extensions** in the top menu bar.\n(On Mac, it is **Lens** > **Extensions**.)\n2. For the extension you want to disable, open the context menu (click on the three vertical dots) and choose **Disable**.\n The example above logs messages when the extension is enabled and disabled.
"},{"location":"extensions/guides/renderer-extension/#clusterpages","title":"clusterPages","text":"Cluster pages appear in the cluster dashboard. Use cluster pages to display information about or add functionality to the active cluster. It is also possible to include custom details from other clusters. Use your extension to access Kubernetes resources in the active cluster with ClusterStore.getInstance().
Add a cluster page definition to a Renderer.LensExtension subclass with the following example:
import { Renderer } from \"@k8slens/extensions\";\nimport { ExampleIcon, ExamplePage } from \"./page\";\nimport React from \"react\";\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nclusterPages = [\n{\nid: \"hello\",\ncomponents: {\nPage: () => <ExamplePage extension={this} />,\n},\n},\n];\n}\n clusterPages is an array of objects that satisfy the PageRegistration interface. The properties of the clusterPages array objects are defined as follows:
id is a string that identifies the page.components matches the PageComponents interface for which there is one field, Page.Page is of type React.ComponentType<any>. It offers flexibility in defining the appearance and behavior of your page.ExamplePage in the example above can be defined in page.tsx:
import { Renderer } from \"@k8slens/extensions\";\nimport React from \"react\";\n\nexport class ExamplePage extends React.Component<{\nextension: LensRendererExtension;\n}> {\nrender() {\nreturn (\n<div>\n<p>Hello world!</p>\n</div>\n);\n}\n}\n Note that the ExamplePage class defines the extension property. This allows the ExampleExtension object to be passed in the cluster page definition in the React style. This way, ExamplePage can access all ExampleExtension subclass data.
The above example shows how to create a cluster page, but not how to make that page available to the Lens user. Use clusterPageMenus, covered in the next section, to add cluster pages to the Lens UI.
clusterPageMenus","text":"clusterPageMenus allows you to add cluster page menu items to the secondary left nav, below Lens's standard cluster menus like Workloads, Custom Resources, etc.
By expanding on the above example, you can add a cluster page menu item to the ExampleExtension definition:
import { Renderer } from \"@k8slens/extensions\";\nimport { ExampleIcon, ExamplePage } from \"./page\";\nimport React from \"react\";\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nclusterPages = [\n{\nid: \"hello\",\ncomponents: {\nPage: () => <ExamplePage extension={this} />,\n},\n},\n];\n\nclusterPageMenus = [\n{\ntarget: { pageId: \"hello\" },\ntitle: \"Hello World\",\ncomponents: {\nIcon: ExampleIcon,\n},\n},\n];\n}\n clusterPageMenus is an array of objects that satisfy the ClusterPageMenuRegistration interface. This element defines how the cluster page menu item will appear and what it will do when you click it. The properties of the clusterPageMenus array objects are defined as follows:
target links to the relevant cluster page using pageId.pageId takes the value of the relevant cluster page's id property.title sets the name of the cluster page menu item that will appear in the left side menu.components is used to set an icon that appears to the left of the title text in the left side menu.The above example creates a menu item that reads Hello World. When users click Hello World, the cluster dashboard will show the contents of Example Page.
This example requires the definition of another React-based component, ExampleIcon, which has been added to page.tsx, as follows:
import { Renderer } from \"@k8slens/extensions\";\nimport React from \"react\";\n\ntype IconProps = Renderer.Component.IconProps;\n\nconst {\nComponent: { Icon },\n} = Renderer;\n\nexport function ExampleIcon(props: IconProps) {\nreturn <Icon {...props} material=\"pages\" tooltip={\"Hi!\"} />;\n}\n\nexport class ExamplePage extends React.Component<{\nextension: Renderer.LensExtension;\n}> {\nrender() {\nreturn (\n<div>\n<p>Hello world!</p>\n</div>\n);\n}\n}\n Lens includes various built-in components available for extension developers to use. One of these is the Renderer.Component.Icon, introduced in ExampleIcon, which you can use to access any of the icons available at Material Design. The properties that Renderer.Component.Icon uses are defined as follows:
material takes the name of the icon you want to use.tooltip sets the text you want to appear when a user hovers over the icon.clusterPageMenus can also be used to define sub menu items, so that you can create groups of cluster pages. The following example groups two sub menu items under one parent menu item:
import { Renderer } from \"@k8slens/extensions\";\nimport { ExampleIcon, ExamplePage } from \"./page\";\nimport React from \"react\";\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nclusterPages = [\n{\nid: \"hello\",\ncomponents: {\nPage: () => <ExamplePage extension={this} />,\n},\n},\n{\nid: \"bonjour\",\ncomponents: {\nPage: () => <ExamplePage extension={this} />,\n},\n},\n];\n\nclusterPageMenus = [\n{\nid: \"example\",\ntitle: \"Greetings\",\ncomponents: {\nIcon: ExampleIcon,\n},\n},\n{\nparentId: \"example\",\ntarget: { pageId: \"hello\" },\ntitle: \"Hello World\",\ncomponents: {\nIcon: ExampleIcon,\n},\n},\n{\nparentId: \"example\",\ntarget: { pageId: \"bonjour\" },\ntitle: \"Bonjour le monde\",\ncomponents: {\nIcon: ExampleIcon,\n},\n},\n];\n}\n The above defines two cluster pages and three cluster page menu objects. The cluster page definitions are straightforward. The three cluster page menu objects include one parent menu item and two sub menu items. The first cluster page menu object defines the parent of a foldout submenu. Setting the id field in a cluster page menu definition implies that it is defining a foldout submenu. Also note that the target field is not specified (it is ignored if the id field is specified). This cluster page menu object specifies the title and components fields, which are used in displaying the menu item in the cluster dashboard sidebar. Initially the submenu is hidden. Activating this menu item toggles on and off the appearance of the submenu below it. The remaining two cluster page menu objects define the contents of the submenu. A cluster page menu object is defined to be a submenu item by setting the parentId field to the id of the parent of a foldout submenu, \"example\" in this case.
This is what the example could look like, including how the menu item will appear in the secondary left nav:
"},{"location":"extensions/guides/renderer-extension/#globalpages","title":"globalPages","text":"Global pages are independent of the cluster dashboard and can fill the entire Lens UI. Their primary use is to display information and provide functionality across clusters (or catalog entities), including customized data and functionality unique to your extension.
Unlike cluster pages, users can trigger global pages even when there is no active cluster (or catalog entity).
The following example defines a Renderer.LensExtension subclass with a single global page definition:
import { Renderer } from \"@k8slens/extensions\";\nimport { HelpPage } from \"./page\";\nimport React from \"react\";\n\nexport default class HelpExtension extends Renderer.LensExtension {\nglobalPages = [\n{\nid: \"help\",\ncomponents: {\nPage: () => <HelpPage extension={this} />,\n},\n},\n];\n}\n globalPages is an array of objects that satisfy the PageRegistration interface. The properties of the globalPages array objects are defined as follows:
id is a string that identifies the page.components matches the PageComponents interface for which there is one field, Page.Page is of type React.ComponentType<any>. It offers flexibility in defining the appearance and behavior of your page.HelpPage in the example above can be defined in page.tsx:
import { Renderer } from \"@k8slens/extensions\";\nimport React from \"react\";\n\nexport class HelpPage extends React.Component<{\nextension: LensRendererExtension;\n}> {\nrender() {\nreturn (\n<div>\n<p>Help yourself</p>\n</div>\n);\n}\n}\n Note that the HelpPage class defines the extension property. This allows the HelpExtension object to be passed in the global page definition in the React-style. This way, HelpPage can access all HelpExtension subclass data.
This example code shows how to create a global page, but not how to make that page available to the Lens user. Global pages are typically made available in the following ways:
appMenus in the Main Extension guide.statusBarItems.welcomeMenus.welcomeMenus","text":""},{"location":"extensions/guides/renderer-extension/#apppreferences","title":"appPreferences","text":"The Lens Preferences page is a built-in global page. You can use Lens extensions to add custom preferences to the Preferences page, providing a single location for users to configure global options.
The following example demonstrates adding a custom preference:
import { Renderer } from \"@k8slens/extensions\";\nimport {\nExamplePreferenceHint,\nExamplePreferenceInput,\n} from \"./src/example-preference\";\nimport { observable } from \"mobx\";\nimport React from \"react\";\n\nexport default class ExampleRendererExtension extends Renderer.LensExtension {\n@observable preference = { enabled: false };\n\nappPreferences = [\n{\ntitle: \"Example Preferences\",\ncomponents: {\nInput: () => <ExamplePreferenceInput preference={this.preference} />,\nHint: () => <ExamplePreferenceHint />,\n},\n},\n];\n}\n appPreferences is an array of objects that satisfies the AppPreferenceRegistration interface. The properties of the appPreferences array objects are defined as follows:
title sets the heading text displayed on the Preferences page.components specifies two React.Component objects that define the interface for the preference.Input specifies an interactive input element for the preference.Hint provides descriptive information for the preference, shown below the Input element.Note
Note that the input and the hint can be comprised of more sophisticated elements, according to the needs of the extension.
ExamplePreferenceInput expects its React props to be set to an ExamplePreferenceProps instance. This is how ExampleRendererExtension handles the state of the preference input. ExampleRendererExtension has a preference field, which you will add to ExamplePreferenceInput.
In this example ExamplePreferenceInput, ExamplePreferenceHint, and ExamplePreferenceProps are defined in ./src/example-preference.tsx as follows:
import { Renderer } from \"@k8slens/extensions\";\nimport { makeObservable } from \"mobx\";\nimport { observer } from \"mobx-react\";\nimport React from \"react\";\n\nconst {\nComponent: { Checkbox },\n} = Renderer;\n\nexport class ExamplePreferenceProps {\npreference: {\nenabled: boolean;\n};\n}\n\n@observer\nexport class ExamplePreferenceInput extends React.Component<ExamplePreferenceProps> {\npublic constructor() {\nsuper({ preference: { enabled: false } });\nmakeObservable(this);\n}\n\nrender() {\nconst { preference } = this.props;\nreturn (\n<Checkbox\nlabel=\"I understand appPreferences\"\nvalue={preference.enabled}\nonChange={(v) => {\npreference.enabled = v;\n}}\n/>\n);\n}\n}\n\nexport class ExamplePreferenceHint extends React.Component {\nrender() {\nreturn <span>This is an example of an appPreference for extensions.</span>;\n}\n}\n ExamplePreferenceInput implements a simple checkbox using Lens's Renderer.Component.Checkbox using the following properties:
label sets the text that displays next to the checkbox.value is initially set to preference.enabled.onChange is a function that responds when the state of the checkbox changes.ExamplePreferenceInput is defined with the ExamplePreferenceProps React props. This is an object with the single enabled property. It is used to indicate the state of the preference, and it is bound to the checkbox state in onChange.
ExamplePreferenceHint is a simple text span.
The above example introduces the decorators makeObservable and observer from the mobx and mobx-react packages. mobx simplifies state management. Without it, this example would not visually update the checkbox properly when the user activates it. Lens uses mobx extensively for state management of its own UI elements. We recommend that extensions rely on it, as well. Alternatively, you can use React's state management, though mobx is typically simpler to use.
Note that you can manage an extension's state data using an ExtensionStore object, which conveniently handles persistence and synchronization. To simplify this guide, the example above defines a preference field in the ExampleRendererExtension class definition to hold the extension's state. However, we recommend that you manage your extension's state data using ExtensionStore.
topBarItems","text":""},{"location":"extensions/guides/renderer-extension/#statusbaritems","title":"statusBarItems","text":"The status bar is the blue strip along the bottom of the Lens UI. statusBarItems are React.ReactNode types. They can be used to display status information, or act as links to global pages as well as external pages.
The following example adds a statusBarItems definition and a globalPages definition to a LensRendererExtension subclass. It configures the status bar item to navigate to the global page upon activation (normally a mouse click):
import { Renderer } from \"@k8slens/extensions\";\nimport { HelpIcon, HelpPage } from \"./page\";\nimport React from \"react\";\n\nexport default class HelpExtension extends Renderer.LensExtension {\nglobalPages = [\n{\nid: \"help\",\ncomponents: {\nPage: () => <HelpPage extension={this} />,\n},\n},\n];\n\nstatusBarItems = [\n{\ncomponents: {\nItem: () => (\n<div\nclassName=\"flex align-center gaps\"\nonClick={() => this.navigate(\"help\")}\n>\n<HelpIcon />\nMy Status Bar Item\n</div>\n),\n},\n},\n];\n}\n The properties of the statusBarItems array objects are defined as follows:
Item specifies the React.Component that will be shown on the status bar. By default, items are added starting from the right side of the status bar. Due to limited space in the status bar, Item will typically specify only an icon or a short string of text. The example above reuses the HelpIcon from the globalPageMenus guide.onClick determines what the statusBarItem does when it is clicked. In the example, onClick is set to a function that calls the LensRendererExtension navigate() method. navigate takes the id of the associated global page as a parameter. Thus, clicking the status bar item activates the associated global pages.kubeObjectMenuItems","text":"An extension can add custom menu items (kubeObjectMenuItems) for specific Kubernetes resource kinds and apiVersions. kubeObjectMenuItems appear under the vertical ellipsis for each listed resource in the cluster dashboard:
They also appear on the title bar of the details page for specific resources:
The following example shows how to add a kubeObjectMenuItems for namespace resources with an associated action:
import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\nimport { NamespaceMenuItem } from \"./src/namespace-menu-item\";\n\ntype KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;\ntype Namespace = Renderer.K8sApi.Namespace;\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nkubeObjectMenuItems = [\n{\nkind: \"Namespace\",\napiVersions: [\"v1\"],\ncomponents: {\nMenuItem: (props: KubeObjectMenuProps<Namespace>) => (\n<NamespaceMenuItem {...props} />\n),\n},\n},\n];\n}\n kubeObjectMenuItems is an array of objects matching the KubeObjectMenuRegistration interface. The example above adds a menu item for namespaces in the cluster dashboard. The properties of the kubeObjectMenuItems array objects are defined as follows:
kind specifies the Kubernetes resource type the menu item will apply to.apiVersion specifies the Kubernetes API version number to use with the resource type.components defines the menu item's appearance and behavior.MenuItem provides a function that returns a React.Component given a set of menu item properties. In this example a NamespaceMenuItem object is returned.NamespaceMenuItem is defined in ./src/namespace-menu-item.tsx:
import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: { terminalStore, MenuItem, Icon },\nNavigation,\n} = Renderer;\n\ntype KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;\ntype Namespace = Renderer.K8sApi.Namespace;\n\nexport function NamespaceMenuItem(props: KubeObjectMenuProps<Namespace>) {\nconst { object: namespace, toolbar } = props;\nif (!namespace) return null;\n\nconst namespaceName = namespace.getName();\n\nconst sendToTerminal = (command: string) => {\nterminalStore.sendCommand(command, {\nenter: true,\nnewTab: true,\n});\nNavigation.hideDetails();\n};\n\nconst getPods = () => {\nsendToTerminal(`kubectl get pods -n ${namespaceName}`);\n};\n\nreturn (\n<MenuItem onClick={getPods}>\n<Icon\nmaterial=\"speaker_group\"\ninteractive={toolbar}\ntitle=\"Get pods in terminal\"\n/>\n<span className=\"title\">Get Pods</span>\n</MenuItem>\n);\n}\n NamespaceMenuItem returns a Renderer.Component.MenuItem which defines the menu item's appearance and its behavior when activated via the onClick property. In the example, getPods() opens a terminal tab and runs kubectl to get a list of pods running in the current namespace.
The name of the namespace is retrieved from props passed into NamespaceMenuItem(). namespace is the props.object, which is of type Renderer.K8sApi.Namespace. Renderer.K8sApi.Namespace is the API for accessing namespaces. The current namespace in this example is simply given by namespace.getName(). Thus, kubeObjectMenuItems afford convenient access to the specific resource selected by the user.
kubeObjectDetailItems","text":"An extension can add custom details (kubeObjectDetailItems) for specified Kubernetes resource kinds and apiVersions. These custom details appear on the details page for a specific resource, such as a Namespace as shown here:
The following example shows how to use kubeObjectDetailItems to add a tabulated list of pods to the Namespace resource details page:
import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\nimport { NamespaceDetailsItem } from \"./src/namespace-details-item\";\n\ntype KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;\ntype KubeObjectDetailsProps = Renderer.Component.KubeObjectDetailsProps;\ntype Namespace = Renderer.K8sApi.Namespace;\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nkubeObjectDetailItems = [\n{\nkind: \"Namespace\",\napiVersions: [\"v1\"],\npriority: 10,\ncomponents: {\nDetails: (props: KubeObjectDetailsProps<Namespace>) => (\n<NamespaceDetailsItem {...props} />\n),\n},\n},\n];\n}\n kubeObjectDetailItems is an array of objects matching the KubeObjectDetailRegistration interface. This example above adds a detail item for namespaces in the cluster dashboard. The properties of the kubeObjectDetailItems array objects are defined as follows:
kind specifies the Kubernetes resource type the detail item will apply to.apiVersion specifies the Kubernetes API version number to use with the resource type.components defines the detail item's appearance and behavior.Details provides a function that returns a React.Component given a set of detail item properties. In this example a NamespaceDetailsItem object is returned.NamespaceDetailsItem is defined in ./src/namespace-details-item.tsx:
import { Renderer } from \"@k8slens/extensions\";\nimport { PodsDetailsList } from \"./pods-details-list\";\nimport React from \"react\";\nimport { observable } from \"mobx\";\nimport { observer } from \"mobx-react\";\n\nconst {\nK8sApi: { podsApi },\nComponent: { DrawerTitle },\n} = Renderer;\n\ntype KubeObjectMenuProps = Renderer.Component.KubeObjectMenuProps;\ntype Namespace = Renderer.K8sApi.Namespace;\ntype Pod = Renderer.K8sApi.Pod;\n\n@observer\nexport class NamespaceDetailsItem extends React.Component<\nKubeObjectDetailsProps<Namespace>\n> {\n@observable private pods: Pod[];\n\nasync componentDidMount() {\nconst namespace = this.props.object.getName();\n\nthis.pods = await podsApi.list({ namespace });\n}\n\nrender() {\nreturn (\n<div>\n<DrawerTitle>Pods</DrawerTitle>\n<PodsDetailsList pods={this.pods} />\n</div>\n);\n}\n}\n Since NamespaceDetailsItem extends React.Component<KubeObjectDetailsProps<Namespace>>, it can access the current namespace object (type Namespace) through this.props.object. You can query this object for many details about the current namespace. In the example above, componentDidMount() gets the namespace's name using the Namespace getName() method. Use the namespace's name to limit the list of pods only to those in the relevant namespace. To get this list of pods, this example uses the Kubernetes pods API podsApi.list() method. The podsApi is automatically configured for the active cluster.
Note that podsApi.list() is an asynchronous method. Getting the pods list should occur prior to rendering the NamespaceDetailsItem. It is a common technique in React development to await async calls in componentDidMount(). However, componentDidMount() is called right after the first call to render(). In order to effect a subsequent render() call, React must be made aware of a state change. Like in the appPreferences guide, mobx and mobx-react are used to ensure NamespaceDetailsItem renders when the pods list updates. This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer.
Finally, the NamespaceDetailsItem renders using the render() method. Details are placed in drawers, and using Renderer.Component.DrawerTitle provides a separator from details above this one. Multiple details in a drawer can be placed in <Renderer.Component.DrawerItem> elements for further separation, if desired. The rest of this example's details are defined in PodsDetailsList, found in ./pods-details-list.tsx:
import React from \"react\";\nimport { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: { TableHead, TableRow, TableCell, Table },\n} = Renderer;\n\ntype Pod = Renderer.K8sApi.Pod;\n\ninterface PodsDetailsListProps {\npods?: Pod[];\n}\n\nexport class PodsDetailsList extends React.Component<PodsDetailsListProps> {\ngetTableRow = (pod: Pod) => {\nreturn (\n<TableRow key={index} nowrap>\n<TableCell className=\"podName\">{pods[index].getName()}</TableCell>\n<TableCell className=\"podAge\">{pods[index].getAge()}</TableCell>\n<TableCell className=\"podStatus\">{pods[index].getStatus()}</TableCell>\n</TableRow>\n);\n};\n\nrender() {\nconst { pods } = this.props;\n\nif (!pods?.length) {\nreturn null;\n}\n\nreturn (\n<div>\n<Table>\n<TableHead>\n<TableCell className=\"podName\">Name</TableCell>\n<TableCell className=\"podAge\">Age</TableCell>\n<TableCell className=\"podStatus\">Status</TableCell>\n</TableHead>\n{pods.map(this.getTableRow)}\n</Table>\n</div>\n);\n}\n}\n PodsDetailsList produces a simple table showing a list of the pods found in this namespace:
Obtain the name, age, and status for each pod using the Renderer.K8sApi.Pod methods. Construct the table using the Renderer.Component.Table and related elements.
For each pod the name, age, and status are obtained using the Renderer.K8sApi.Pod methods. The table is constructed using the Renderer.Component.Table and related elements. See Component documentation for further details.
kubeObjectStatusTexts","text":""},{"location":"extensions/guides/renderer-extension/#kubeworkloadsoverviewitems","title":"kubeWorkloadsOverviewItems","text":""},{"location":"extensions/guides/renderer-extension/#entitysettings","title":"entitySettings","text":""},{"location":"extensions/guides/renderer-extension/#catalogentitydetailitems","title":"catalogEntityDetailItems","text":""},{"location":"extensions/guides/renderer-extension/#commandpalettecommands","title":"commandPaletteCommands","text":""},{"location":"extensions/guides/renderer-extension/#protocolhandlers","title":"protocolHandlers","text":"See the Protocol Handlers Guide
"},{"location":"extensions/guides/resource-stack/","title":"Resource Stack (Cluster Feature)","text":"A cluster feature is a set of Kubernetes resources that can be applied to and managed within the active cluster. The Renderer.K8sApi.ResourceStack class provides the functionality to input and apply kubernetes resources to a cluster. It is up to the extension developer to manage the life cycle of the resource stack. It could be applied automatically to a cluster by the extension, or the end-user could be required to install it.
The code examples in this section show how to create a resource stack, and define a cluster feature that is configurable from the cluster Settings page.
Info
To access the cluster Settings page, right-click the relevant cluster in the left side menu and click Settings.
The resource stack in this example consists of a single kubernetes resource:
apiVersion: v1\nkind: Pod\nmetadata:\nname: example-pod\nspec:\ncontainers:\n- name: example-pod\nimage: nginx\n It is simply a pod named example-pod, running nginx. Assume this content is in the file ../resources/example-pod.yml.
The following code sample shows how to use the Renderer.K8sApi.ResourceStack to manage installing and uninstalling this resource stack:
import { Renderer, Common } from \"@k8slens/extensions\";\nimport * as path from \"path\";\n\nconst {\nK8sApi: {\nResourceStack,\nforCluster,\nPod,\n}\n} = Renderer;\n\ntype ResourceStack = Renderer.K8sApi.ResourceStack;\ntype Pod = Renderer.K8sApi.Pod;\ntype KubernetesCluster = Common.Catalog.KubernetesCluster;\n\nexport class ExampleClusterFeature {\nprotected stack: ResourceStack;\n\nconstructor(protected cluster: KubernetesCluster) {\nthis.stack = new ResourceStack(cluster, \"example-resource-stack\");\n}\n\nget resourceFolder() {\nreturn path.join(__dirname, \"../resources/\");\n}\n\ninstall(): Promise<string> {\nconsole.log(\"installing example-pod\");\nreturn this.stack.kubectlApplyFolder(this.resourceFolder);\n}\n\nasync isInstalled(): Promise<boolean> {\ntry {\nconst podApi = forCluster(this.cluster, Pod);\nconst examplePod = await podApi.get({name: \"example-pod\", namespace: \"default\"});\n\nif (examplePod?.kind) {\nconsole.log(\"found example-pod\");\nreturn true;\n}\n} catch(e) {\nconsole.log(\"Error getting example-pod:\", e);\n}\nconsole.log(\"didn't find example-pod\");\n\nreturn false;\n}\n\nasync uninstall(): Promise<string> {\nconsole.log(\"uninstalling example-pod\");\nreturn this.stack.kubectlDeleteFolder(this.resourceFolder);\n}\n}\n The ExampleClusterFeature class constructor takes a Common.Catalog.KubernetesCluster argument. This is the cluster that the resource stack will be applied to, and the constructor instantiates a Renderer.K8sApi.ResourceStack as such. ExampleClusterFeature implements an install() method which simply invokes the kubectlApplyFolder() method of the Renderer.K8sApi.ResourceStack class. kubectlApplyFolder() applies to the cluster all kubernetes resources found in the folder passed to it, in this case ../resources. Similarly, ExampleClusterFeature implements an uninstall() method which simply invokes the kubectlDeleteFolder() method of the Renderer.K8sApi.ResourceStack class. kubectlDeleteFolder() tries to delete from the cluster all kubernetes resources found in the folder passed to it, again in this case ../resources.
ExampleClusterFeature also implements an isInstalled() method, which demonstrates how you can utilize the kubernetes api to inspect the resource stack status. isInstalled() simply tries to find a pod named example-pod, as a way to determine if the pod is already installed. This method can be useful in creating a context-sensitive UI for installing/uninstalling the feature, as demonstrated in the next sample code.
To allow the end-user to control the life cycle of this cluster feature the following code sample shows how to implement a user interface based on React and custom Lens UI components:
import React from \"react\";\nimport { Common, Renderer } from \"@k8slens/extensions\";\nimport { observer } from \"mobx-react\";\nimport { computed, observable, makeObservable } from \"mobx\";\nimport { ExampleClusterFeature } from \"./example-cluster-feature\";\n\nconst {\nComponent: {\nSubTitle, Button,\n}\n} = Renderer;\n\ninterface ExampleClusterFeatureSettingsProps {\ncluster: Common.Catalog.KubernetesCluster;\n}\n\n@observer\nexport class ExampleClusterFeatureSettings extends React.Component<ExampleClusterFeatureSettingsProps> {\nconstructor(props: ExampleClusterFeatureSettingsProps) {\nsuper(props);\nmakeObservable(this);\n}\n\n@observable installed = false;\n@observable inProgress = false;\n\nfeature: ExampleClusterFeature;\n\nasync componentDidMount() {\nthis.feature = new ExampleClusterFeature(this.props.cluster);\n\nawait this.updateFeatureState();\n}\n\nasync updateFeatureState() {\nthis.installed = await this.feature.isInstalled();\n}\n\nasync save() {\nthis.inProgress = true;\n\ntry {\nif (this.installed) {\nawait this.feature.uninstall();\n} else {\nawait this.feature.install();\n}\n} finally {\nthis.inProgress = false;\n\nawait this.updateFeatureState();\n}\n}\n\n@computed get buttonLabel()\u00a0{\nif (this.inProgress && this.installed) return \"Uninstalling ...\";\nif (this.inProgress) return \"Applying ...\";\n\nif (this.installed) {\nreturn \"Uninstall\";\n}\n\nreturn \"Apply\";\n}\n\nrender() {\nreturn (\n<>\n<section>\n<SubTitle title=\"Example Cluster Feature using a Resource Stack\" />\n<Button\nlabel={this.buttonLabel}\nwaiting={this.inProgress}\nonClick={() => this.save()}\nprimary />\n</section>\n</>\n);\n}\n}\n The ExampleClusterFeatureSettings class extends React.Component and simply renders a subtitle and a button. ExampleClusterFeatureSettings takes the cluster as a prop and when the React component has mounted the ExampleClusterFeature is instantiated using this cluster (in componentDidMount()). The rest of the logic concerns the button appearance and action, based on the ExampleClusterFeatureSettings fields installed and inProgress. The installed value is of course determined using the aforementioned ExampleClusterFeature method isInstalled(). The inProgress value is true while waiting for the feature to be installed (or uninstalled).
Note that the button is a Renderer.Component.Button element and this example takes advantage of its waiting prop to show a \"waiting\" animation while the install (or uninstall) is in progress. Using elements from Renderer.Component is encouraged, to take advantage of their built-in properties, and to ensure a common look and feel.
Also note that MobX 6 is used for state management, ensuring that the UI is rerendered when state has changed. The ExampleClusterFeatureSettings class is marked as an @observer, and its constructor must call makeObservable(). As well, the installed and inProgress fields are marked as @observable, ensuring that the button gets rerendered any time these fields change.
Finally, ExampleClusterFeatureSettings needs to be connected to the extension, and would typically appear on the cluster Settings page via a Renderer.LensExtension.entitySettings entry. The ExampleExtension would look like this:
import { Common, Renderer } from \"@k8slens/extensions\";\nimport { ExampleClusterFeatureSettings } from \"./src/example-cluster-feature-settings\"\nimport React from \"react\"\n\nexport default class ExampleExtension extends Renderer.LensExtension {\nentitySettings = [\n{\napiVersions: [\"entity.k8slens.dev/v1alpha1\"],\nkind: \"KubernetesCluster\",\ntitle: \"Example Cluster Feature\",\npriority: 5,\ncomponents: {\nView: ({ entity = null }: { entity: Common.Catalog.KubernetesCluster}) => (\n<ExampleClusterFeatureSettings cluster={entity} />\n)\n}\n}\n];\n\n}\n An entity setting is added to the entitySettings array field of the Renderer.LensExtension class. Because Lens's catalog can contain different kinds of entities, the kind must be identified. For more details about the catalog see the Catalog Guide. Clusters are a built-in kind, so the apiVersions and kind fields should be set as above. The title is shown as a navigation item on the cluster Settings page and the components.View is displayed when the navigation item is clicked on. The components.View definition above shows how the ExampleClusterFeatureSettings element is included, and how its cluster prop is set. priority determines the order of the entity settings, the higher the number the higher in the navigation panel the setting is placed. The default value is 50.
The final result looks like this:
ExampleClusterFeature and ExampleClusterFeatureSettings demonstrate a cluster feature for a simple resource stack. In practice a resource stack can include many resources, and require more sophisticated life cycle management (upgrades, partial installations, etc.) Using Renderer.K8sApi.ResourceStack and entitySettings it is possible to implement solutions for more complex cluster features. The Lens Metrics setting (on the cluster Settings page) is a good example of an advanced solution.
Stores are components that persist and synchronize state data. Lens uses a number of stores to maintain various kinds of state information, including:
ClusterStore manages cluster state data (such as cluster details), and it tracks which cluster is active.WorkspaceStore manages workspace state data (such as the workspace name), and and it tracks which clusters belong to a given workspace.ExtensionStore manages custom extension state data.This guide focuses on the ExtensionStore.
Extension developers can create their own store for managing state data by extending the ExtensionStore class. This guide shows how to create a store for the appPreferences guide example, which demonstrates how to add a custom preference to the Preferences page. The preference is a simple boolean that indicates whether or not something is enabled. However, in the example, the enabled state is not stored anywhere, and it reverts to the default when Lens is restarted.
Store.ExtensionStore's child class will need to be created before being used. It is recommended to call the inherited static method getInstanceOrCreate() only in one place, generally within you extension's onActivate() method. It is also recommenced to delete the instance, using the inherited static method resetInstance(), in your extension's onDeactivate() method. Everywhere else in your code you should use the getInstance() static method. This is so that your data is kept up to date and not persisted longer than expected.
The following example code creates a store for the appPreferences guide example:
import { Common } from \"@k8slens/extensions\";\nimport { observable, makeObservable } from \"mobx\";\n\nexport type ExamplePreferencesModel = {\nenabled: boolean;\n};\n\nexport class ExamplePreferencesStore extends Common.Store.ExtensionStore<ExamplePreferencesModel> {\n\n@observable enabled = false;\n\nprivate constructor() {\nsuper({\nconfigName: \"example-preferences-store\",\ndefaults: {\nenabled: false\n}\n});\nmakeObservable(this);\n}\n\nprotected fromStore({ enabled }: ExamplePreferencesModel): void {\nthis.enabled = enabled;\n}\n\ntoJSON(): ExamplePreferencesModel {\nreturn {\nenabled: this.enabled\n};\n}\n}\n First, our example defines the extension's data model using the simple ExamplePreferencesModel type. This has a single field, enabled, which represents the preference's state. ExamplePreferencesStore extends Store.ExtensionStore, which is based on the ExamplePreferencesModel. The enabled field is added to the ExamplePreferencesStore class to hold the \"live\" or current state of the preference. Note the use of the observable decorator on the enabled field. The appPreferences guide example uses MobX for the UI state management, ensuring the checkbox updates when it's activated by the user.
Next, our example implements the constructor and two abstract methods. The constructor specifies the name of the store (\"example-preferences-store\") and the default (initial) value for the preference state (enabled: false). Lens internals call the fromStore() method when the store loads. It gives the extension the opportunity to retrieve the stored state data values based on the defined data model. The enabled field of the ExamplePreferencesStore is set to the value from the store whenever fromStore() is invoked. The toJSON() method is complementary to fromStore(). It is called when the store is being saved. toJSON() must provide a JSON serializable object, facilitating its storage in JSON format.
Finally, ExamplePreferencesStore is created by calling ExamplePreferencesStore.getInstanceOrCreate(), and exported for use by other parts of the extension. Note that ExamplePreferencesStore is a singleton. Calling this function will create an instance if one has not been made before. Through normal use you should call ExamplePreferencesStore.getInstance() as that will throw an error if an instance does not exist. This provides some logical safety in that it limits where a new instance can be created. Thus it prevents an instance from being created when the constructor args are not present at the call site.
If you are doing some cleanup it is recommended to call ExamplePreferencesStore.getInstance(false) which returns undefined instead of throwing when there is no instance.
The following example code, modified from the appPreferences guide demonstrates how to use the extension store. ExamplePreferencesStore must be loaded in the main process, where loaded stores are automatically saved when exiting Lens. This can be done in ./main.ts:
import { Main } from \"@k8slens/extensions\";\nimport { ExamplePreferencesStore } from \"./src/example-preference-store\";\n\nexport default class ExampleMainExtension extends Main.LensExtension {\nasync onActivate() {\nawait ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this);\n}\n}\n Here, ExamplePreferencesStore loads with ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this), which is conveniently called from the onActivate() method of ExampleMainExtension. Similarly, ExamplePreferencesStore must load in the renderer process where the appPreferences are handled. This can be done in ./renderer.ts:
import { Renderer } from \"@k8slens/extensions\";\nimport { ExamplePreferenceHint, ExamplePreferenceInput } from \"./src/example-preference\";\nimport { ExamplePreferencesStore } from \"./src/example-preference-store\";\nimport React from \"react\";\n\nexport default class ExampleRendererExtension extends Renderer.LensExtension {\n\nasync onActivate() {\nawait ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this);\n}\n\nappPreferences = [\n{\ntitle: \"Example Preferences\",\ncomponents: {\nInput: () => <ExamplePreferenceInput />,\nHint: () => <ExamplePreferenceHint/>\n}\n}\n];\n}\n Again, ExamplePreferencesStore.getInstanceOrCreate().loadExtension(this) is called to load ExamplePreferencesStore, this time from the onActivate() method of ExampleRendererExtension.
ExamplePreferenceInput is defined in ./src/example-preference.tsx:
import { Renderer } from \"@k8slens/extensions\";\nimport { observer } from \"mobx-react\";\nimport React from \"react\";\nimport { ExamplePreferencesStore } from \"./example-preference-store\";\n\nconst {\nComponent: {\nCheckbox,\n},\n} = Renderer;\n\n@observer\nexport class ExamplePreferenceInput extends React.Component {\n\nrender() {\nreturn (\n<Checkbox\nlabel=\"I understand appPreferences\"\nvalue={ExamplePreferencesStore.getInstance().enabled}\nonChange={v => { ExamplePreferencesStore.getInstance().enabled = v; }}\n/>\n);\n}\n}\n\nexport class ExamplePreferenceHint extends React.Component {\nrender() {\nreturn (\n<span>This is an example of an appPreference for extensions.</span>\n);\n}\n}\n The only change here is that ExamplePreferenceProps defines its preference field as an ExamplePreferencesStore type. Everything else works as before, except that now the enabled state persists across Lens restarts because it is managed by the ExamplePreferencesStore.
Lens uses MobX on top of React's state management system. The result is a more declarative state management style, rather than React's native setState mechanism.
You can review how React handles state management here.
The following is a quick overview:
React.Component is generic with respect to both props and state (which default to the empty object type).props should be considered read-only from the point of view of the component, and it is the mechanism for passing in arguments to a component.state is a component's internal state, and can be read by accessing the super-class field state.state must be updated using the setState parent method which merges the new data with the old state.setState calls.MobX is a package that provides an abstraction over React's state management system. The three main concepts are:
observable is a marker for data stored in the component's state.action is a function that modifies any observable data.computed is a marker for data that is derived from observable data, but that is not actually stored. Think of this as computing isEmpty rather than an observable field called count.Further reading is available on the MobX website.
"},{"location":"extensions/testing-and-publishing/publishing/","title":"Publishing Extensions","text":"To be able to easily share extensions with users they need to be published somewhere. Lens currently only supports installing extensions from NPM tarballs. All hosted extensions must, therefore, be retrievable in a NPM tarball.
"},{"location":"extensions/testing-and-publishing/publishing/#places-to-host-your-extension","title":"Places To Host Your Extension","text":"We recommend to host your extension somewhere on the web so that it is easy for people to search for and download it. We recommend either hosting it as an NPM package on https://www.npmjs.com or through GitHub releases. We recommend against using GitHub packages (https://github.com/features/packages) as it requires a GitHub token to access the package.
"},{"location":"extensions/testing-and-publishing/publishing/#publishing-via-npm","title":"Publishing via NPM","text":"This is the easiest method of publishing as NPM comes built in with mechanism to get a link to download the package as a tarball. Once you have set up an account with NPM (https://www.npmjs.com/signup) and logged in with their CLI (npm login) you will be ready to publish.
npm version <major|minor|patch> to bump the version of your extension by the appropriate amount.npm publish to publish your extension to NPMgit push && git push --tags to push the commit that NPM creates to your git remote.It is probably a good idea to put into your README.md the following instructions for your users to get the tarball download link.
npm view <extension-name> dist.tarball\n This will output the link that they will need to give to Lens to install your extension.
"},{"location":"extensions/testing-and-publishing/publishing/#publish-via-github-releases","title":"Publish via GitHub Releases","text":"Another method of publishing your extensions is to do so with the releases mechanism built into GitHub. We recommend reading GitHub's Releases Documentation for how to actually do the steps of a release. The following will be a quick walk through on how to make the tarball which will be the released file.
"},{"location":"extensions/testing-and-publishing/publishing/#making-a-npm-tarball-of-your-extension","title":"Making a NPM Tarball of Your Extension","text":"While this is necessary for hosting on GitHub releases, this is also the means for creating a tarball if you plan on hosting on a different file hosting platform.
Say you have your project folder at ~/my-extension/ and you want to create an NPM package we need to do the following within your git repo:
npm pack\n This will create a NPM tarball that can be hosted on GitHub Releases or any other publicly available file hosting service.
"},{"location":"extensions/testing-and-publishing/testing/","title":"Testing Extensions","text":""},{"location":"extensions/testing-and-publishing/testing/#renderer-process-unit-testing","title":"Renderer Process Unit Testing","text":"UI components in the extension's renderer process are based on React/ReactDOM. These components can be tested by popular React testing tools like React Testing Library.
If you are using the Yeoman Lens Extension Generator to scaffold extension project then the testing environment for render process is already set up for you. Just use npm start or yarn test to run the tests.
For example, I have a component GlobalPageMenuIcon and want to test if props.navigate is called when user clicks the icon.
My component GlobalPageMenuIcon
import React from \"react\"\nimport { Renderer } from \"@k8slens/extensions\";\n\nconst {\nComponent: {\nIcon,\n},\n} = Renderer;\n\nconst GlobalPageMenuIcon = ({ navigate }: { navigate?: () => void }): JSX.Element => (\n<Icon\nmaterial=\"trip_origin\"\nonClick={() => navigate()}\ndata-testid=\"global-page-menu-icon\"\n/>\n)\n The test
import React from \"react\"\nimport { render, screen, fireEvent } from \"@testing-library/react\";\n\nimport GlobalPageMenuIcon from \"./GlobalPageMenuIcon\";\n\ntest(\"click called navigate()\", () => {\nconst navigate = jest.fn();\nrender(<GlobalPageMenuIcon navigate={navigate} />);\nfireEvent.click(screen.getByTestId(\"global-page-menu-icon\"));\nexpect(navigate).toHaveBeenCalled();\n});\n In the example we used React Testing Library but any React testing framework can be used to test renderer process UI components.
There are more example tests in the generator's template. Extend your tests based on the examples.
"},{"location":"extensions/testing-and-publishing/testing/#main-process-unit-testing","title":"Main Process Unit Testing","text":"Code in the extension's main process consists of normal JavaScript files that have access to extension api, you can write unit tests using any testing framework.
If you are using the Yeoman Lens Extension Generator to scaffold your extension project then the Jest testing environment is set up for you. Just use npm start or yarn test to run the tests.
Extension developers might find console.log() useful for printing out information and errors from extensions. To use console.log(), note that Lens is based on Electron, and that Electron has two types of processes: Main and Renderer.
In the Renderer process, console.log() is printed in the Console in Developer Tools (View > Toggle Developer Tools).
Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools.
"},{"location":"extensions/testing-and-publishing/testing/#macos","title":"macOS","text":"On macOS, view the Main process logs by running Lens from the terminal:
/Applications/Lens.app/Contents/MacOS/Lens\n You can also use Console.app to view the Main process logs.
"},{"location":"extensions/testing-and-publishing/testing/#linux","title":"Linux","text":"On Linux, you can access the Main process logs using the Lens PID. First get the PID:
ps aux | grep Lens | grep -v grep\n Then get the Main process logs using the PID:
tail -f /proc/[pid]/fd/1 # stdout (console.log)\ntail -f /proc/[pid]/fd/2 # stdout (console.error)\n"},{"location":"extensions/usage/","title":"Using Extensions","text":"The features that Lens includes out-of-the-box are just the start. Lens extensions let you add new features to your installation to support your workflow. Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. The start using Lens Extensions go to File (or Lens on macOS) > Extensions in the application menu. This is the Extensions management page where all the management of the extensions you want to use is done.
There are three ways to install extensions. If you have the extension as a .tgz file then dragging and dropping it in the extension management page will install it for you. If it is hosted on the web, you can paste the URL and click Install and Lens will download and install it. The third way is to move the extension into your ~/.k8slens/extensions (or C:\\Users\\<user>\\.k8slens\\extensions) folder and Lens will automatically detect it and install the extension.
Go to the extension management page and click either the Enable or Disable buttons. Extensions will be enabled by default when you first install them. A disabled extension is not loaded by Lens and is not run.
If, for whatever reason, you wish to remove the installation of an extension simple click the Uninstall button. This will remove all the files that Lens would need to run the extension.