diff --git a/master/extensions/api/interfaces/Renderer.K8sApi.MetricData/index.html b/master/extensions/api/interfaces/Renderer.K8sApi.MetricData/index.html new file mode 100644 index 0000000000..ab0a056391 --- /dev/null +++ b/master/extensions/api/interfaces/Renderer.K8sApi.MetricData/index.html @@ -0,0 +1,882 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: MetricData - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: MetricData#

+

Renderer.K8sApi.MetricData

+

Copyright (c) OpenLens Authors. All rights reserved. +Licensed under MIT License. See LICENSE in root directory for more information.

+

Table of contents#

+

Properties#

+ +

Properties#

+

data#

+

• data: Object

+

Type declaration#

+ + + + + + + + + + + + + + + + + +
NameType
resultMetricResult[]
resultTypestring
+
+

status#

+

• status: string

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/master/extensions/api/interfaces/Renderer.K8sApi.MetricResult/index.html b/master/extensions/api/interfaces/Renderer.K8sApi.MetricResult/index.html new file mode 100644 index 0000000000..adde1d6afb --- /dev/null +++ b/master/extensions/api/interfaces/Renderer.K8sApi.MetricResult/index.html @@ -0,0 +1,898 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: MetricResult - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: MetricResult#

+

Renderer.K8sApi.MetricResult

+

Table of contents#

+

Properties#

+ +

Properties#

+

metric#

+

• metric: Object

+

Index signature#

+

▪ [name: string]: string | undefined

+

Type declaration#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType
instance?string
kubernetes?string
kubernetes_namespace?string
kubernetes_node?string
node?string
pod?string
+
+

values#

+

• values: [number, string][]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/master/extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/index.html b/master/extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/index.html new file mode 100644 index 0000000000..1a4b09de94 --- /dev/null +++ b/master/extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/index.html @@ -0,0 +1,903 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: RequestMetricsParams - Lens Extension Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: RequestMetricsParams#

+

Renderer.K8sApi.RequestMetricsParams

+

Table of contents#

+

Properties#

+ +

Properties#

+

end#

+

• Optional end: string | number

+

timestamp in seconds or valid date-string

+
+

namespace#

+

• Optional namespace: string

+

rbac-proxy validation param

+
+

range#

+

• Optional range: number

+

time-range in seconds for data aggregation

+

Default

+

3600 (1 hour)

+
+

start#

+

• Optional start: string | number

+

timestamp in seconds or valid date-string

+
+

step#

+

• Optional step: number

+

step in seconds

+

Default

+

60 (1 minute)

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/master/extensions/api/modules/Renderer.K8sApi/index.html b/master/extensions/api/modules/Renderer.K8sApi/index.html index 1745bd2b77..fccd27ad3e 100644 --- a/master/extensions/api/modules/Renderer.K8sApi/index.html +++ b/master/extensions/api/modules/Renderer.K8sApi/index.html @@ -1198,6 +1198,13 @@ PodsApi + + +
  • + + RequestMetrics + +
    • @@ -1525,6 +1532,13 @@ isAllowedResource + + +
  • + + requestMetrics + +
    • @@ -1648,6 +1662,9 @@
  • IKubeApiCluster
  • IgnoredKubeApiOptions
  • KubeObjectStatus
    • +
  • MetricData
    • +
  • MetricResult
    • +
  • RequestMetricsParams

    • Type Aliases#

    Variables#

    References#

    BaseKubeJsonApiObjectMetadata#

    @@ -1901,6 +1920,9 @@

    PodsApi#

    Ƭ PodsApi: PodApi

    +
    +

    RequestMetrics#

    +

    Ƭ RequestMetrics: ReturnType<typeof requestMetricsInjectable["instantiate"]>

    Variables#

    DeploymentApi#

    • DeploymentApi: (opts?: DerivedKubeApiOptions) => DeploymentApi

    @@ -2375,6 +2397,89 @@

    Returns#

    boolean

    +
    +

    requestMetrics#

    +

    ▸ requestMetrics(query, params?): Promise<MetricData>

    +

    Parameters#

    + + + + + + + + + + + + + + + + + +
    NameType
    querystring
    params?RequestMetricsParams
    +

    Returns#

    +

    Promise<MetricData>

    +

    ▸ requestMetrics(query, params?): Promise<MetricData[]>

    +

    Parameters#

    + + + + + + + + + + + + + + + + + +
    NameType
    querystring[]
    params?RequestMetricsParams
    +

    Returns#

    +

    Promise<MetricData[]>

    +

    ▸ requestMetrics<Keys>(query, params?): Promise<Record<Keys, MetricData>>

    +

    Type parameters#

    + + + + + + + + + + + + + +
    NameType
    Keysextends string
    +

    Parameters#

    + + + + + + + + + + + + + + + + + +
    NameType
    queryRecord<Keys, Partial<Record<string, string>>>
    params?RequestMetricsParams
    +

    Returns#

    +

    Promise<Record<Keys, MetricData>>

    diff --git a/master/search/search_index.json b/master/search/search_index.json index e9c43353b6..132346387a 100644 --- a/master/search/search_index.json +++ b/master/search/search_index.json @@ -1 +1 @@ -{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Lens Extension API # 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: How to build, run, test, and publish an extension. How to take full advantage of the Lens Extension API. Where to find guides and code samples to help get you started. What Extensions Can Do # Here are some examples of what you can achieve with the Extension API: Add custom components & views in the UI - Extending the Lens Workbench 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. How to Build Extensions # Here is what each section of the Lens Extension API docs can help you with: Getting Started teaches fundamental concepts for building extensions with the Hello World sample. Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics. Extension Guides includes guides and code samples that explain specific usages of Lens Extension API. Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions. API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics. What's New # 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 . Important changes since Lens v4 # 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. Looking for Help # If you have questions for extension development, try asking on the Lens Dev Slack . 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 . Downloading Lens # Download Lens for macOS, Windows, or Linux.","title":"Overview"},{"location":"#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: How to build, run, test, and publish an extension. How to take full advantage of the Lens Extension API. Where to find guides and code samples to help get you started.","title":"Lens Extension API"},{"location":"#what-extensions-can-do","text":"Here are some examples of what you can achieve with the Extension API: Add custom components & views in the UI - Extending the Lens Workbench 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.","title":"What Extensions Can Do"},{"location":"#how-to-build-extensions","text":"Here is what each section of the Lens Extension API docs can help you with: Getting Started teaches fundamental concepts for building extensions with the Hello World sample. Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics. Extension Guides includes guides and code samples that explain specific usages of Lens Extension API. Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions. API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics.","title":"How to Build Extensions"},{"location":"#whats-new","text":"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 .","title":"What's New"},{"location":"#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.","title":"Important changes since Lens v4"},{"location":"#looking-for-help","text":"If you have questions for extension development, try asking on the Lens Dev Slack . 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 .","title":"Looking for Help"},{"location":"#downloading-lens","text":"Download Lens for macOS, Windows, or Linux.","title":"Downloading Lens"},{"location":"architecture/decisions/","text":"Architecture Decision Records #","title":"Architecture Decision Records"},{"location":"architecture/decisions/#architecture-decision-records","text":"","title":"Architecture Decision Records"},{"location":"extensions/extension-migration/","text":"Lens v4 to v5 Extension Migration Notes # Lens v5 inspects the version of the extension to ensure it is compatible. The package.json for your extension must have an \"engines\" field specifying the lens version that your extension is targeted for, e.g: \"engines\": { \"lens\": \"^5.0.0-beta.7\" }, Note that Lens v5 supports all the range semantics that semver provides. Types and components have been reorganized, many have been grouped by process ( 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. The 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. The 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. Lens v5 now relies on mobx 6 for state management. Extensions that use mobx will need to be modified to work with mobx 6. See Migrating from Mobx 4/5 for specific details. For an example of an existing extension that is compatible with Lens v5 see the Lens Resource Map Extension","title":"Lens v4 to v5 Extension Migration Notes"},{"location":"extensions/extension-migration/#lens-v4-to-v5-extension-migration-notes","text":"Lens v5 inspects the version of the extension to ensure it is compatible. The package.json for your extension must have an \"engines\" field specifying the lens version that your extension is targeted for, e.g: \"engines\": { \"lens\": \"^5.0.0-beta.7\" }, Note that Lens v5 supports all the range semantics that semver provides. Types and components have been reorganized, many have been grouped by process ( 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. The 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. The 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. Lens v5 now relies on mobx 6 for state management. Extensions that use mobx will need to be modified to work with mobx 6. See Migrating from Mobx 4/5 for specific details. For an example of an existing extension that is compatible with Lens v5 see the Lens Resource Map Extension","title":"Lens v4 to v5 Extension Migration Notes"},{"location":"extensions/api/","text":"Extension API Reference # APIs # Common Main Renderer","title":"API Reference"},{"location":"extensions/api/#extension-api-reference","text":"","title":"Extension API Reference"},{"location":"extensions/api/#apis","text":"Common Main Renderer","title":"APIs"},{"location":"extensions/api/modules/","text":"@k8slens/extensions # Table of contents # Namespaces # Common Main Renderer","title":"@k8slens/extensions"},{"location":"extensions/api/modules/#k8slensextensions","text":"","title":"@k8slens/extensions"},{"location":"extensions/api/modules/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/#namespaces","text":"Common Main Renderer","title":"Namespaces"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/","text":"Class: CatalogCategory # Common . Catalog .CatalogCategory Hierarchy # CatalogCategory_base \u21b3 CatalogCategory \u21b3\u21b3 KubernetesClusterCategory Table of contents # Constructors # constructor Properties # apiVersion filters kind metadata spec Methods # addMenuFilter filteredItems getBadge getId getName parseId Constructors # constructor # \u2022 new CatalogCategory () Inherited from # CatalogCategory_base.constructor Properties # apiVersion # \u2022 Readonly Abstract apiVersion : string The version of category that you are wanting to declare. Currently supported values: \"catalog.k8slens.dev/v1alpha1\" filters # \u2022 Protected Readonly filters : ObservableSet < AddMenuFilter > kind # \u2022 Readonly Abstract kind : string The kind of item you wish to declare. Currently supported values: \"CatalogCategory\" metadata # \u2022 Readonly Abstract metadata : CatalogCategoryMetadata The data about the category itself spec # \u2022 Readonly Abstract spec : CatalogCategorySpec The most important part of a category, as it is where entity versions are declared. Methods # addMenuFilter # \u25b8 addMenuFilter ( fn ): Disposer Add a filter for menu items of catalogAddMenu Parameters # Name Type Description fn AddMenuFilter The function that should return a truthy value if that menu item should be displayed Returns # Disposer A function to remove that filter filteredItems # \u25b8 filteredItems ( menuItems ): CatalogEntityAddMenu [] Filter menuItems according to the Category's set filters Parameters # Name Type Description menuItems CatalogEntityAddMenu [] menu items to filter Returns # CatalogEntityAddMenu [] filtered menu items getBadge # \u25b8 getBadge (): ReactNode Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu Returns # ReactNode getId # \u25b8 getId (): string Get the ID of this category Returns # string getName # \u25b8 getName (): string Get the name of this category Returns # string parseId # \u25b8 Static parseId ( id ): Object Parse a category ID into parts. Parameters # Name Type Description id string The id of a category is parse Returns # Object The group and kind parts of the ID Name Type group? string kind? string","title":"Class: CatalogCategory"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#class-catalogcategory","text":"Common . Catalog .CatalogCategory","title":"Class: CatalogCategory"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#hierarchy","text":"CatalogCategory_base \u21b3 CatalogCategory \u21b3\u21b3 KubernetesClusterCategory","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#properties","text":"apiVersion filters kind metadata spec","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#methods","text":"addMenuFilter filteredItems getBadge getId getName parseId","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#constructor","text":"\u2022 new CatalogCategory ()","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#apiversion","text":"\u2022 Readonly Abstract apiVersion : string The version of category that you are wanting to declare. Currently supported values: \"catalog.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#filters","text":"\u2022 Protected Readonly filters : ObservableSet < AddMenuFilter >","title":"filters"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#kind","text":"\u2022 Readonly Abstract kind : string The kind of item you wish to declare. Currently supported values: \"CatalogCategory\"","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#metadata","text":"\u2022 Readonly Abstract metadata : CatalogCategoryMetadata The data about the category itself","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#spec","text":"\u2022 Readonly Abstract spec : CatalogCategorySpec The most important part of a category, as it is where entity versions are declared.","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#addmenufilter","text":"\u25b8 addMenuFilter ( fn ): Disposer Add a filter for menu items of catalogAddMenu","title":"addMenuFilter"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#filtereditems","text":"\u25b8 filteredItems ( menuItems ): CatalogEntityAddMenu [] Filter menuItems according to the Category's set filters","title":"filteredItems"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getbadge","text":"\u25b8 getBadge (): ReactNode Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu","title":"getBadge"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getid","text":"\u25b8 getId (): string Get the ID of this category","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getname","text":"\u25b8 getName (): string Get the name of this category","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#parseid","text":"\u25b8 Static parseId ( id ): Object Parse a category ID into parts.","title":"parseId"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/","text":"Class: CatalogEntity # Common . Catalog .CatalogEntity Type parameters # Name Type Metadata extends CatalogEntityMetadata = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec Hierarchy # CatalogEntity \u21b3 KubernetesCluster \u21b3 GeneralEntity \u21b3 WebLink Implements # CatalogEntityKindData Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status Methods # getId getName getSource isEnabled onContextMenuOpen onRun onSettingsOpen Constructors # constructor # \u2022 new CatalogEntity < Metadata , Status , Spec >( \u00abdestructured\u00bb ) Type parameters # Name Type Metadata extends CatalogEntityMetadata < Metadata > = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec Parameters # Name Type \u00abdestructured\u00bb CatalogEntityData < Metadata , Status , Spec > Properties # apiVersion # \u2022 Readonly Abstract apiVersion : string The group and version of this class. Implementation of # CatalogEntityKindData . apiVersion kind # \u2022 Readonly Abstract kind : string A DNS label name of the entity. Implementation of # CatalogEntityKindData . kind metadata # \u2022 metadata : Metadata spec # \u2022 spec : Spec status # \u2022 status : Status Methods # getId # \u25b8 getId (): string Get the UID of this entity Returns # string getName # \u25b8 getName (): string Get the name of this entity Returns # string getSource # \u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided Returns # string isEnabled # \u25b8 isEnabled (): boolean Get if this entity is enabled. Returns # boolean onContextMenuOpen # \u25b8 Optional onContextMenuOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntityContextMenuContext Returns # void | Promise < void > onRun # \u25b8 Optional onRun ( context ): void | Promise < void > Parameters # Name Type context CatalogEntityActionContext Returns # void | Promise < void > onSettingsOpen # \u25b8 Optional onSettingsOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntitySettingsContext Returns # void | Promise < void >","title":"Class: CatalogEntity"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#class-catalogentitymetadata-status-spec","text":"Common . Catalog .CatalogEntity","title":"Class: CatalogEntity<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#type-parameters","text":"Name Type Metadata extends CatalogEntityMetadata = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec","title":"Type parameters"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#hierarchy","text":"CatalogEntity \u21b3 KubernetesCluster \u21b3 GeneralEntity \u21b3 WebLink","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#implements","text":"CatalogEntityKindData","title":"Implements"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#properties","text":"apiVersion kind metadata spec status","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#methods","text":"getId getName getSource isEnabled onContextMenuOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#constructor","text":"\u2022 new CatalogEntity < Metadata , Status , Spec >( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#apiversion","text":"\u2022 Readonly Abstract apiVersion : string The group and version of this class.","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#kind","text":"\u2022 Readonly Abstract kind : string A DNS label name of the entity.","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#spec","text":"\u2022 spec : Spec","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#status","text":"\u2022 status : Status","title":"status"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getid","text":"\u25b8 getId (): string Get the UID of this entity","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getname","text":"\u25b8 getName (): string Get the name of this entity","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getsource","text":"\u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided","title":"getSource"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#isenabled","text":"\u25b8 isEnabled (): boolean Get if this entity is enabled.","title":"isEnabled"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#oncontextmenuopen","text":"\u25b8 Optional onContextMenuOpen ( context ): void | Promise < void >","title":"onContextMenuOpen"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#onrun","text":"\u25b8 Optional onRun ( context ): void | Promise < void >","title":"onRun"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#onsettingsopen","text":"\u25b8 Optional onSettingsOpen ( context ): void | Promise < void >","title":"onSettingsOpen"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/","text":"Class: GeneralEntity # Common . Catalog .GeneralEntity Hierarchy # CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec > \u21b3 GeneralEntity Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status Methods # getId getName getSource isEnabled onContextMenuOpen onRun onSettingsOpen Constructors # constructor # \u2022 new GeneralEntity ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb CatalogEntityData < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" The group and version of this class. Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : \"General\" A DNS label name of the entity. Overrides # CatalogEntity . kind metadata # \u2022 metadata : CatalogEntityMetadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : GeneralEntitySpec Inherited from # CatalogEntity . spec status # \u2022 status : CatalogEntityStatus Inherited from # CatalogEntity . status Methods # getId # \u25b8 getId (): string Get the UID of this entity Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Get the name of this entity Returns # string Inherited from # CatalogEntity . getName getSource # \u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided Returns # string Inherited from # CatalogEntity . getSource isEnabled # \u25b8 isEnabled (): boolean Get if this entity is enabled. Returns # boolean Inherited from # CatalogEntity . isEnabled onContextMenuOpen # \u25b8 Optional onContextMenuOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntityContextMenuContext Returns # void | Promise < void > Inherited from # CatalogEntity . onContextMenuOpen onRun # \u25b8 onRun ( context ): Promise < void > Parameters # Name Type context CatalogEntityActionContext Returns # Promise < void > Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 Optional onSettingsOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntitySettingsContext Returns # void | Promise < void > Inherited from # CatalogEntity . onSettingsOpen","title":"Class: GeneralEntity"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#class-generalentity","text":"Common . Catalog .GeneralEntity","title":"Class: GeneralEntity"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#hierarchy","text":"CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec > \u21b3 GeneralEntity","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#properties","text":"apiVersion kind metadata spec status","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#methods","text":"getId getName getSource isEnabled onContextMenuOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#constructor","text":"\u2022 new GeneralEntity ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#apiversion","text":"\u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" The group and version of this class.","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#kind","text":"\u2022 Readonly kind : \"General\" A DNS label name of the entity.","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#metadata","text":"\u2022 metadata : CatalogEntityMetadata","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#spec","text":"\u2022 spec : GeneralEntitySpec","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#status","text":"\u2022 status : CatalogEntityStatus","title":"status"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getid","text":"\u25b8 getId (): string Get the UID of this entity","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getname","text":"\u25b8 getName (): string Get the name of this entity","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getsource","text":"\u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided","title":"getSource"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#isenabled","text":"\u25b8 isEnabled (): boolean Get if this entity is enabled.","title":"isEnabled"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#oncontextmenuopen","text":"\u25b8 Optional onContextMenuOpen ( context ): void | Promise < void >","title":"onContextMenuOpen"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#onrun","text":"\u25b8 onRun ( context ): Promise < void >","title":"onRun"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#onsettingsopen","text":"\u25b8 Optional onSettingsOpen ( context ): void | Promise < void >","title":"onSettingsOpen"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/","text":"Class: KubernetesCluster # Common . Catalog .KubernetesCluster Type parameters # Name Type Metadata extends KubernetesClusterMetadata = KubernetesClusterMetadata Status extends KubernetesClusterStatus = KubernetesClusterStatus Spec extends KubernetesClusterSpec = KubernetesClusterSpec Hierarchy # CatalogEntity < Metadata , Status , Spec > \u21b3 KubernetesCluster Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiVersion kind Methods # connect disconnect getId getName getSource isEnabled onContextMenuOpen onDetailsOpen onRun onSettingsOpen Constructors # constructor # \u2022 new KubernetesCluster < Metadata , Status , Spec >( \u00abdestructured\u00bb ) Type parameters # Name Type Metadata extends KubernetesClusterMetadata < Metadata > = KubernetesClusterMetadata Status extends KubernetesClusterStatus = KubernetesClusterStatus Spec extends KubernetesClusterSpec < Spec > = KubernetesClusterSpec Parameters # Name Type \u00abdestructured\u00bb CatalogEntityData < Metadata , Status , Spec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : string The group and version of this class. Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : string A DNS label name of the entity. Overrides # CatalogEntity . kind metadata # \u2022 metadata : Metadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : Spec Inherited from # CatalogEntity . spec status # \u2022 status : Status Inherited from # CatalogEntity . status apiVersion # \u25aa Static Readonly apiVersion : string kind # \u25aa Static Readonly kind : string Methods # connect # \u25b8 connect (): Promise < void > Returns # Promise < void > disconnect # \u25b8 disconnect (): Promise < void > Returns # Promise < void > getId # \u25b8 getId (): string Get the UID of this entity Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Get the name of this entity Returns # string Inherited from # CatalogEntity . getName getSource # \u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided Returns # string Inherited from # CatalogEntity . getSource isEnabled # \u25b8 isEnabled (): boolean Get if this entity is enabled. Returns # boolean Inherited from # CatalogEntity . isEnabled onContextMenuOpen # \u25b8 onContextMenuOpen ( context ): void Parameters # Name Type context CatalogEntityContextMenuContext Returns # void Overrides # CatalogEntity . onContextMenuOpen onDetailsOpen # \u25b8 onDetailsOpen (): void Returns # void onRun # \u25b8 onRun ( context ): Promise < void > Parameters # Name Type context CatalogEntityActionContext Returns # Promise < void > Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 onSettingsOpen (): void Returns # void Overrides # CatalogEntity . onSettingsOpen","title":"Class: KubernetesCluster"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#class-kubernetesclustermetadata-status-spec","text":"Common . Catalog .KubernetesCluster","title":"Class: KubernetesCluster<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#type-parameters","text":"Name Type Metadata extends KubernetesClusterMetadata = KubernetesClusterMetadata Status extends KubernetesClusterStatus = KubernetesClusterStatus Spec extends KubernetesClusterSpec = KubernetesClusterSpec","title":"Type parameters"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#hierarchy","text":"CatalogEntity < Metadata , Status , Spec > \u21b3 KubernetesCluster","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#properties","text":"apiVersion kind metadata spec status apiVersion kind","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#methods","text":"connect disconnect getId getName getSource isEnabled onContextMenuOpen onDetailsOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#constructor","text":"\u2022 new KubernetesCluster < Metadata , Status , Spec >( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#apiversion","text":"\u2022 Readonly apiVersion : string The group and version of this class.","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#kind","text":"\u2022 Readonly kind : string A DNS label name of the entity.","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#spec","text":"\u2022 spec : Spec","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#status","text":"\u2022 status : Status","title":"status"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#apiversion_1","text":"\u25aa Static Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#kind_1","text":"\u25aa Static Readonly kind : string","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#connect","text":"\u25b8 connect (): Promise < void >","title":"connect"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#disconnect","text":"\u25b8 disconnect (): Promise < void >","title":"disconnect"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getid","text":"\u25b8 getId (): string Get the UID of this entity","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getname","text":"\u25b8 getName (): string Get the name of this entity","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getsource","text":"\u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided","title":"getSource"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#isenabled","text":"\u25b8 isEnabled (): boolean Get if this entity is enabled.","title":"isEnabled"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#oncontextmenuopen","text":"\u25b8 onContextMenuOpen ( context ): void","title":"onContextMenuOpen"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#ondetailsopen","text":"\u25b8 onDetailsOpen (): void","title":"onDetailsOpen"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#onrun","text":"\u25b8 onRun ( context ): Promise < void >","title":"onRun"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#onsettingsopen","text":"\u25b8 onSettingsOpen (): void","title":"onSettingsOpen"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/","text":"Class: KubernetesClusterCategory # Common . Catalog .KubernetesClusterCategory Hierarchy # CatalogCategory \u21b3 KubernetesClusterCategory Table of contents # Constructors # constructor Properties # apiVersion filters kind metadata spec Methods # addMenuFilter filteredItems getBadge getId getName parseId Constructors # constructor # \u2022 new KubernetesClusterCategory () Inherited from # CatalogCategory . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"catalog.k8slens.dev/v1alpha1\" The version of category that you are wanting to declare. Currently supported values: \"catalog.k8slens.dev/v1alpha1\" Overrides # CatalogCategory . apiVersion filters # \u2022 Protected Readonly filters : ObservableSet < AddMenuFilter > Inherited from # CatalogCategory . filters kind # \u2022 Readonly kind : \"CatalogCategory\" The kind of item you wish to declare. Currently supported values: \"CatalogCategory\" Overrides # CatalogCategory . kind metadata # \u2022 metadata : Object The data about the category itself Type declaration # Name Type icon string name string Overrides # CatalogCategory . metadata spec # \u2022 spec : CatalogCategorySpec The most important part of a category, as it is where entity versions are declared. Overrides # CatalogCategory . spec Methods # addMenuFilter # \u25b8 addMenuFilter ( fn ): Disposer Add a filter for menu items of catalogAddMenu Parameters # Name Type Description fn AddMenuFilter The function that should return a truthy value if that menu item should be displayed Returns # Disposer A function to remove that filter Inherited from # CatalogCategory . addMenuFilter filteredItems # \u25b8 filteredItems ( menuItems ): CatalogEntityAddMenu [] Filter menuItems according to the Category's set filters Parameters # Name Type Description menuItems CatalogEntityAddMenu [] menu items to filter Returns # CatalogEntityAddMenu [] filtered menu items Inherited from # CatalogCategory . filteredItems getBadge # \u25b8 getBadge (): ReactNode Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu Returns # ReactNode Inherited from # CatalogCategory . getBadge getId # \u25b8 getId (): string Get the ID of this category Returns # string Inherited from # CatalogCategory . getId getName # \u25b8 getName (): string Get the name of this category Returns # string Inherited from # CatalogCategory . getName parseId # \u25b8 Static parseId ( id ): Object Parse a category ID into parts. Parameters # Name Type Description id string The id of a category is parse Returns # Object The group and kind parts of the ID Name Type group? string kind? string Inherited from # CatalogCategory . parseId","title":"Class: KubernetesClusterCategory"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#class-kubernetesclustercategory","text":"Common . Catalog .KubernetesClusterCategory","title":"Class: KubernetesClusterCategory"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#hierarchy","text":"CatalogCategory \u21b3 KubernetesClusterCategory","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#properties","text":"apiVersion filters kind metadata spec","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#methods","text":"addMenuFilter filteredItems getBadge getId getName parseId","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#constructor","text":"\u2022 new KubernetesClusterCategory ()","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#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\"","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#filters","text":"\u2022 Protected Readonly filters : ObservableSet < AddMenuFilter >","title":"filters"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#kind","text":"\u2022 Readonly kind : \"CatalogCategory\" The kind of item you wish to declare. Currently supported values: \"CatalogCategory\"","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#metadata","text":"\u2022 metadata : Object The data about the category itself","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#spec","text":"\u2022 spec : CatalogCategorySpec The most important part of a category, as it is where entity versions are declared.","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#addmenufilter","text":"\u25b8 addMenuFilter ( fn ): Disposer Add a filter for menu items of catalogAddMenu","title":"addMenuFilter"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#filtereditems","text":"\u25b8 filteredItems ( menuItems ): CatalogEntityAddMenu [] Filter menuItems according to the Category's set filters","title":"filteredItems"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#getbadge","text":"\u25b8 getBadge (): ReactNode Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu","title":"getBadge"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#getid","text":"\u25b8 getId (): string Get the ID of this category","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#getname","text":"\u25b8 getName (): string Get the name of this category","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#parseid","text":"\u25b8 Static parseId ( id ): Object Parse a category ID into parts.","title":"parseId"},{"location":"extensions/api/classes/Common.Catalog.WebLink/","text":"Class: WebLink # Common . Catalog .WebLink Hierarchy # CatalogEntity < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > \u21b3 WebLink Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiVersion kind Methods # getId getName getSource isEnabled onContextMenuOpen onRun onSettingsOpen Constructors # constructor # \u2022 new WebLink ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb CatalogEntityData < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" The group and version of this class. Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : \"WebLink\" A DNS label name of the entity. Overrides # CatalogEntity . kind metadata # \u2022 metadata : CatalogEntityMetadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : WebLinkSpec Inherited from # CatalogEntity . spec status # \u2022 status : WebLinkStatus Inherited from # CatalogEntity . status apiVersion # \u25aa Static Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" kind # \u25aa Static Readonly kind : \"WebLink\" Methods # getId # \u25b8 getId (): string Get the UID of this entity Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Get the name of this entity Returns # string Inherited from # CatalogEntity . getName getSource # \u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided Returns # string Inherited from # CatalogEntity . getSource isEnabled # \u25b8 isEnabled (): boolean Get if this entity is enabled. Returns # boolean Inherited from # CatalogEntity . isEnabled onContextMenuOpen # \u25b8 onContextMenuOpen ( context ): void Parameters # Name Type context CatalogEntityContextMenuContext Returns # void Overrides # CatalogEntity . onContextMenuOpen onRun # \u25b8 onRun (): Promise < void > Returns # Promise < void > Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 Optional onSettingsOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntitySettingsContext Returns # void | Promise < void > Inherited from # CatalogEntity . onSettingsOpen","title":"Class: WebLink"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#class-weblink","text":"Common . Catalog .WebLink","title":"Class: WebLink"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#hierarchy","text":"CatalogEntity < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > \u21b3 WebLink","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#properties","text":"apiVersion kind metadata spec status apiVersion kind","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#methods","text":"getId getName getSource isEnabled onContextMenuOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#constructor","text":"\u2022 new WebLink ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#apiversion","text":"\u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" The group and version of this class.","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#kind","text":"\u2022 Readonly kind : \"WebLink\" A DNS label name of the entity.","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#metadata","text":"\u2022 metadata : CatalogEntityMetadata","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#spec","text":"\u2022 spec : WebLinkSpec","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#status","text":"\u2022 status : WebLinkStatus","title":"status"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#apiversion_1","text":"\u25aa Static Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#kind_1","text":"\u25aa Static Readonly kind : \"WebLink\"","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getid","text":"\u25b8 getId (): string Get the UID of this entity","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getname","text":"\u25b8 getName (): string Get the name of this entity","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getsource","text":"\u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided","title":"getSource"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#isenabled","text":"\u25b8 isEnabled (): boolean Get if this entity is enabled.","title":"isEnabled"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#oncontextmenuopen","text":"\u25b8 onContextMenuOpen ( context ): void","title":"onContextMenuOpen"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#onrun","text":"\u25b8 onRun (): Promise < void >","title":"onRun"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#onsettingsopen","text":"\u25b8 Optional onSettingsOpen ( context ): void | Promise < void >","title":"onSettingsOpen"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/","text":"Class: EventEmitter # Common . EventBus .EventEmitter Type parameters # Name Type D extends any [] Table of contents # Constructors # constructor Properties # listeners Methods # addListener emit removeAllListeners removeListener Constructors # constructor # \u2022 new EventEmitter < D >() Type parameters # Name Type D extends any [] Properties # listeners # \u2022 Protected listeners : [ EventEmitterCallback < D >, EventEmitterOptions ][] Methods # addListener # \u25b8 addListener ( callback , options? ): void Parameters # Name Type callback EventEmitterCallback < D > options? EventEmitterOptions Returns # void emit # \u25b8 emit ( ...data ): void Parameters # Name Type ...data D Returns # void removeAllListeners # \u25b8 removeAllListeners (): void Returns # void removeListener # \u25b8 removeListener ( callback ): void Parameters # Name Type callback EventEmitterCallback < D > Returns # void","title":"Class: EventEmitter"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#class-eventemitterd","text":"Common . EventBus .EventEmitter","title":"Class: EventEmitter<D>"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#type-parameters","text":"Name Type D extends any []","title":"Type parameters"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#properties","text":"listeners","title":"Properties"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#methods","text":"addListener emit removeAllListeners removeListener","title":"Methods"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#constructor","text":"\u2022 new EventEmitter < D >()","title":"constructor"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#listeners","text":"\u2022 Protected listeners : [ EventEmitterCallback < D >, EventEmitterOptions ][]","title":"listeners"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#addlistener","text":"\u25b8 addListener ( callback , options? ): void","title":"addListener"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#emit","text":"\u25b8 emit ( ...data ): void","title":"emit"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#removealllisteners","text":"\u25b8 removeAllListeners (): void","title":"removeAllListeners"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#removelistener","text":"\u25b8 removeListener ( callback ): void","title":"removeListener"},{"location":"extensions/api/classes/Common.LensExtension/","text":"Class: LensExtension # Common .LensExtension Type parameters # Name Type Dependencies extends LensExtensionDependencies = LensExtensionDependencies Hierarchy # LensExtension \u21b3 LensExtension \u21b3 LensExtension Table of contents # Constructors # constructor Properties # id isBundled manifest manifestPath protocolHandlers Accessors # description isEnabled name sanitizedExtensionId storeName version Methods # activate disable enable getExtensionFileFolder onActivate onDeactivate Constructors # constructor # \u2022 new LensExtension < Dependencies >( \u00abdestructured\u00bb ) Type parameters # Name Type Dependencies extends LensExtensionDependencies = LensExtensionDependencies Parameters # Name Type \u00abdestructured\u00bb InstalledExtension Properties # id # \u2022 Readonly id : string isBundled # \u2022 Readonly isBundled : boolean manifest # \u2022 Readonly manifest : LensExtensionManifest manifestPath # \u2022 Readonly manifestPath : string protocolHandlers # \u2022 protocolHandlers : ProtocolHandlerRegistration [] Accessors # description # \u2022 get description (): undefined | string Returns # undefined | string isEnabled # \u2022 get isEnabled (): boolean Returns # boolean name # \u2022 get name (): string Returns # string sanitizedExtensionId # \u2022 get sanitizedExtensionId (): string Returns # string storeName # \u2022 get storeName (): string Returns # string version # \u2022 get version (): string Returns # string Methods # activate # \u25b8 activate (): Promise < void > Returns # Promise < void > disable # \u25b8 disable (): Promise < void > Returns # Promise < void > enable # \u25b8 enable (): Promise < void > Returns # Promise < void > getExtensionFileFolder # \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. Returns # Promise < string > onActivate # \u25b8 Protected onActivate (): void | Promise < void > Returns # void | Promise < void > onDeactivate # \u25b8 Protected onDeactivate (): void | Promise < void > Returns # void | Promise < void >","title":"Class: LensExtension"},{"location":"extensions/api/classes/Common.LensExtension/#class-lensextensiondependencies","text":"Common .LensExtension","title":"Class: LensExtension<Dependencies>"},{"location":"extensions/api/classes/Common.LensExtension/#type-parameters","text":"Name Type Dependencies extends LensExtensionDependencies = LensExtensionDependencies","title":"Type parameters"},{"location":"extensions/api/classes/Common.LensExtension/#hierarchy","text":"LensExtension \u21b3 LensExtension \u21b3 LensExtension","title":"Hierarchy"},{"location":"extensions/api/classes/Common.LensExtension/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.LensExtension/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.LensExtension/#properties","text":"id isBundled manifest manifestPath protocolHandlers","title":"Properties"},{"location":"extensions/api/classes/Common.LensExtension/#accessors","text":"description isEnabled name sanitizedExtensionId storeName version","title":"Accessors"},{"location":"extensions/api/classes/Common.LensExtension/#methods","text":"activate disable enable getExtensionFileFolder onActivate onDeactivate","title":"Methods"},{"location":"extensions/api/classes/Common.LensExtension/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.LensExtension/#constructor","text":"\u2022 new LensExtension < Dependencies >( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Common.LensExtension/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.LensExtension/#id","text":"\u2022 Readonly id : string","title":"id"},{"location":"extensions/api/classes/Common.LensExtension/#isbundled","text":"\u2022 Readonly isBundled : boolean","title":"isBundled"},{"location":"extensions/api/classes/Common.LensExtension/#manifest","text":"\u2022 Readonly manifest : LensExtensionManifest","title":"manifest"},{"location":"extensions/api/classes/Common.LensExtension/#manifestpath","text":"\u2022 Readonly manifestPath : string","title":"manifestPath"},{"location":"extensions/api/classes/Common.LensExtension/#protocolhandlers","text":"\u2022 protocolHandlers : ProtocolHandlerRegistration []","title":"protocolHandlers"},{"location":"extensions/api/classes/Common.LensExtension/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Common.LensExtension/#description","text":"\u2022 get description (): undefined | string","title":"description"},{"location":"extensions/api/classes/Common.LensExtension/#isenabled","text":"\u2022 get isEnabled (): boolean","title":"isEnabled"},{"location":"extensions/api/classes/Common.LensExtension/#name","text":"\u2022 get name (): string","title":"name"},{"location":"extensions/api/classes/Common.LensExtension/#sanitizedextensionid","text":"\u2022 get sanitizedExtensionId (): string","title":"sanitizedExtensionId"},{"location":"extensions/api/classes/Common.LensExtension/#storename","text":"\u2022 get storeName (): string","title":"storeName"},{"location":"extensions/api/classes/Common.LensExtension/#version","text":"\u2022 get version (): string","title":"version"},{"location":"extensions/api/classes/Common.LensExtension/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.LensExtension/#activate","text":"\u25b8 activate (): Promise < void >","title":"activate"},{"location":"extensions/api/classes/Common.LensExtension/#disable","text":"\u25b8 disable (): Promise < void >","title":"disable"},{"location":"extensions/api/classes/Common.LensExtension/#enable","text":"\u25b8 enable (): Promise < void >","title":"enable"},{"location":"extensions/api/classes/Common.LensExtension/#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.","title":"getExtensionFileFolder"},{"location":"extensions/api/classes/Common.LensExtension/#onactivate","text":"\u25b8 Protected onActivate (): void | Promise < void >","title":"onActivate"},{"location":"extensions/api/classes/Common.LensExtension/#ondeactivate","text":"\u25b8 Protected onDeactivate (): void | Promise < void >","title":"onDeactivate"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/","text":"Class: ExtensionStore # Common . Store .ExtensionStore Type parameters # Name Type T extends object Hierarchy # BaseStore < T > \u21b3 ExtensionStore Table of contents # Constructors # constructor Properties # displayName extension params Methods # cwd fromStore load loadExtension toJSON createInstance getInstance resetInstance Constructors # constructor # \u2022 new ExtensionStore < T >( \u00abdestructured\u00bb ) Type parameters # Name Type T extends object Parameters # Name Type \u00abdestructured\u00bb ExtensionStoreParams < T > Overrides # BaseStore.constructor Properties # displayName # \u2022 Readonly displayName : string Inherited from # BaseStore.displayName extension # \u2022 Protected Optional extension : LensExtension < LensExtensionDependencies > params # \u2022 Protected Readonly params : BaseStoreParams < T > Inherited from # BaseStore.params Methods # cwd # \u25b8 Protected cwd (): string Returns # string Overrides # BaseStore.cwd fromStore # \u25b8 Protected Abstract fromStore ( data ): void fromStore is called internally when a child class syncs with the file system. Note: This function must be synchronous. Parameters # Name Type Description data T the parsed information read from the stored JSON file Returns # void Inherited from # BaseStore.fromStore load # \u25b8 load (): void Returns # void Overrides # BaseStore.load loadExtension # \u25b8 loadExtension ( extension ): void Parameters # Name Type extension LensExtension < LensExtensionDependencies > Returns # void toJSON # \u25b8 Abstract 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. Returns # T Inherited from # BaseStore.toJSON createInstance # \u25b8 Static createInstance < T , R >( this , ...args ): T Deprecated This is a form of global shared state. Just call new Store(...) Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > ...args R Returns # T getInstance # \u25b8 Static getInstance < T , R >( this , strict? ): T Deprecated This is a form of global shared state. Just call new Store(...) Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > strict? true Returns # T \u25b8 Static getInstance < T , R >( this , strict ): undefined | T Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > strict false Returns # undefined | T resetInstance # \u25b8 Static resetInstance (): void Deprecated This is a form of global shared state. Just call new Store(...) Returns # void","title":"Class: ExtensionStore"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#class-extensionstoret","text":"Common . Store .ExtensionStore","title":"Class: ExtensionStore<T>"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#type-parameters","text":"Name Type T extends object","title":"Type parameters"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#hierarchy","text":"BaseStore < T > \u21b3 ExtensionStore","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#properties","text":"displayName extension params","title":"Properties"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#methods","text":"cwd fromStore load loadExtension toJSON createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructor","text":"\u2022 new ExtensionStore < T >( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#displayname","text":"\u2022 Readonly displayName : string","title":"displayName"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#extension","text":"\u2022 Protected Optional extension : LensExtension < LensExtensionDependencies >","title":"extension"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#params","text":"\u2022 Protected Readonly params : BaseStoreParams < T >","title":"params"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#cwd","text":"\u25b8 Protected cwd (): string","title":"cwd"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#fromstore","text":"\u25b8 Protected Abstract fromStore ( data ): void fromStore is called internally when a child class syncs with the file system. Note: This function must be synchronous.","title":"fromStore"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#load","text":"\u25b8 load (): void","title":"load"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#loadextension","text":"\u25b8 loadExtension ( extension ): void","title":"loadExtension"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#tojson","text":"\u25b8 Abstract 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.","title":"toJSON"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#createinstance","text":"\u25b8 Static createInstance < T , R >( this , ...args ): T Deprecated This is a form of global shared state. Just call new Store(...)","title":"createInstance"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#getinstance","text":"\u25b8 Static getInstance < T , R >( this , strict? ): T Deprecated This is a form of global shared state. Just call new Store(...)","title":"getInstance"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#resetinstance","text":"\u25b8 Static resetInstance (): void Deprecated This is a form of global shared state. Just call new Store(...)","title":"resetInstance"},{"location":"extensions/api/classes/Common.Util.Singleton/","text":"Class: Singleton # Common . Util .Singleton Deprecated This is a form of global shared state Table of contents # Constructors # constructor Methods # createInstance getInstance resetInstance Constructors # constructor # \u2022 new Singleton () Methods # createInstance # \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. Type parameters # Name Type T extends Singleton < T > R extends any [] Parameters # Name Type Description this StaticThis < T , R > Implicit argument that is the child class type ...args R The constructor arguments for the child class Returns # T An instance of the child class getInstance # \u25b8 Static getInstance < T , R >( this , strict? ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R extends any [] Parameters # 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 Returns # T An instance of the child class \u25b8 Static getInstance < T , R >( this , strict ): undefined | T Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > strict false Returns # undefined | T resetInstance # \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. Returns # void","title":"Class: Singleton"},{"location":"extensions/api/classes/Common.Util.Singleton/#class-singleton","text":"Common . Util .Singleton Deprecated This is a form of global shared state","title":"Class: Singleton"},{"location":"extensions/api/classes/Common.Util.Singleton/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Util.Singleton/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Util.Singleton/#methods","text":"createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/Common.Util.Singleton/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Util.Singleton/#constructor","text":"\u2022 new Singleton ()","title":"constructor"},{"location":"extensions/api/classes/Common.Util.Singleton/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Util.Singleton/#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.","title":"createInstance"},{"location":"extensions/api/classes/Common.Util.Singleton/#getinstance","text":"\u25b8 Static getInstance < T , R >( this , strict? ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/Common.Util.Singleton/#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.","title":"resetInstance"},{"location":"extensions/api/classes/Main.Ipc/","text":"Class: Ipc # Main .Ipc Hierarchy # IpcRegistrar \u21b3 Ipc Table of contents # Constructors # constructor Properties # [IpcPrefix] extension Methods # broadcast handle listen createInstance getInstance resetInstance Constructors # constructor # \u2022 new Ipc ( extension ) Parameters # Name Type extension LensExtension Overrides # IpcRegistrar.constructor Properties # [IpcPrefix] # \u2022 Readonly [IpcPrefix] : string Inherited from # IpcRegistrar.__@IpcPrefix@1575 extension # \u2022 Protected Readonly extension : LensExtension < LensExtensionDependencies > Inherited from # IpcRegistrar.extension Methods # broadcast # \u25b8 broadcast ( channel , ...args ): void Parameters # Name Type Description channel string The channel to broadcast to your whole extension, both main and renderer ...args any [] The arguments passed to all listeners Returns # void Inherited from # IpcRegistrar.broadcast handle # \u25b8 handle ( channel , handler ): void Declare a RPC over channel . Lens will cleanup when the extension is disabled or uninstalled Parameters # Name Type Description channel string The name of the RPC handler ( event : IpcMainInvokeEvent , ... args : any []) => any The remote procedure that is called Returns # void listen # \u25b8 listen ( channel , listener ): Disposer Listen for broadcasts within your extension Parameters # Name Type Description 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 Returns # Disposer An optional disposer, Lens will cleanup when the extension is disabled or uninstalled even if this is not called createInstance # \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. Type parameters # Name Type T extends Singleton < T > R extends any [] Parameters # Name Type Description this StaticThis < T , R > Implicit argument that is the child class type ...args R The constructor arguments for the child class Returns # T An instance of the child class Inherited from # IpcRegistrar.createInstance getInstance # \u25b8 Static getInstance < T , R >( this , strict? ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R extends any [] Parameters # 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 Returns # T An instance of the child class Inherited from # IpcRegistrar.getInstance \u25b8 Static getInstance < T , R >( this , strict ): undefined | T Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > strict false Returns # undefined | T Inherited from # IpcRegistrar.getInstance resetInstance # \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. Returns # void Inherited from # IpcRegistrar.resetInstance","title":"Class: Ipc"},{"location":"extensions/api/classes/Main.Ipc/#class-ipc","text":"Main .Ipc","title":"Class: Ipc"},{"location":"extensions/api/classes/Main.Ipc/#hierarchy","text":"IpcRegistrar \u21b3 Ipc","title":"Hierarchy"},{"location":"extensions/api/classes/Main.Ipc/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.Ipc/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.Ipc/#properties","text":"[IpcPrefix] extension","title":"Properties"},{"location":"extensions/api/classes/Main.Ipc/#methods","text":"broadcast handle listen createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/Main.Ipc/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.Ipc/#constructor","text":"\u2022 new Ipc ( extension )","title":"constructor"},{"location":"extensions/api/classes/Main.Ipc/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.Ipc/#ipcprefix","text":"\u2022 Readonly [IpcPrefix] : string","title":"[IpcPrefix]"},{"location":"extensions/api/classes/Main.Ipc/#extension","text":"\u2022 Protected Readonly extension : LensExtension < LensExtensionDependencies >","title":"extension"},{"location":"extensions/api/classes/Main.Ipc/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.Ipc/#broadcast","text":"\u25b8 broadcast ( channel , ...args ): void","title":"broadcast"},{"location":"extensions/api/classes/Main.Ipc/#handle","text":"\u25b8 handle ( channel , handler ): void Declare a RPC over channel . Lens will cleanup when the extension is disabled or uninstalled","title":"handle"},{"location":"extensions/api/classes/Main.Ipc/#listen","text":"\u25b8 listen ( channel , listener ): Disposer Listen for broadcasts within your extension","title":"listen"},{"location":"extensions/api/classes/Main.Ipc/#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.","title":"createInstance"},{"location":"extensions/api/classes/Main.Ipc/#getinstance","text":"\u25b8 Static getInstance < T , R >( this , strict? ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/Main.Ipc/#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.","title":"resetInstance"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/","text":"Class: ClusterRole # Main . K8sApi .ClusterRole Hierarchy # KubeObject < ClusterScopedMetadata , void , void > \u21b3 ClusterRole Table of contents # Constructors # constructor Properties # aggregationRule apiVersion kind metadata rules spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ClusterRole ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb ClusterRoleData Overrides # KubeObject . constructor Properties # aggregationRule # \u2022 Optional aggregationRule : AggregationRule apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata rules # \u2022 Optional rules : PolicyRule [] spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRules # \u25b8 getRules (): PolicyRule [] Returns # PolicyRule [] getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < ClusterRole > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ClusterRole"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#class-clusterrole","text":"Main . K8sApi .ClusterRole","title":"Class: ClusterRole"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#hierarchy","text":"KubeObject < ClusterScopedMetadata , void , void > \u21b3 ClusterRole","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#properties","text":"aggregationRule apiVersion kind metadata rules spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#constructor","text":"\u2022 new ClusterRole ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#aggregationrule","text":"\u2022 Optional aggregationRule : AggregationRule","title":"aggregationRule"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#rules","text":"\u2022 Optional rules : PolicyRule []","title":"rules"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getrules","text":"\u25b8 getRules (): PolicyRule []","title":"getRules"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/","text":"Class: ClusterRoleBinding # Main . K8sApi .ClusterRoleBinding Hierarchy # KubeObject < ClusterScopedMetadata , void , void > \u21b3 ClusterRoleBinding Table of contents # Constructors # constructor Properties # apiVersion kind metadata roleRef spec status subjects apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSubjectNames getSubjects getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ClusterRoleBinding ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb ClusterRoleBindingData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata roleRef # \u2022 roleRef : RoleRef spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status subjects # \u2022 Optional subjects : Subject [] apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getSubjectNames # \u25b8 getSubjectNames (): string Returns # string getSubjects # \u25b8 getSubjects (): Subject [] Returns # Subject [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < ClusterRoleBinding > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ClusterRoleBinding"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#class-clusterrolebinding","text":"Main . K8sApi .ClusterRoleBinding","title":"Class: ClusterRoleBinding"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#hierarchy","text":"KubeObject < ClusterScopedMetadata , void , void > \u21b3 ClusterRoleBinding","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#properties","text":"apiVersion kind metadata roleRef spec status subjects apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSubjectNames getSubjects getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#constructor","text":"\u2022 new ClusterRoleBinding ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#roleref","text":"\u2022 roleRef : RoleRef","title":"roleRef"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#subjects","text":"\u2022 Optional subjects : Subject []","title":"subjects"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getsubjectnames","text":"\u25b8 getSubjectNames (): string","title":"getSubjectNames"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getsubjects","text":"\u25b8 getSubjects (): Subject []","title":"getSubjects"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/","text":"Class: ConfigMap # Main . K8sApi .ConfigMap Hierarchy # KubeObject < NamespaceScopedMetadata , void , void > \u21b3 ConfigMap Table of contents # Constructors # constructor Properties # apiVersion binaryData data immutable kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ConfigMap ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb ConfigMapData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion binaryData # \u2022 binaryData : Partial < Record < string , string >> data # \u2022 data : Partial < Record < string , string >> immutable # \u2022 Optional immutable : boolean kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getKeys # \u25b8 getKeys (): string [] Returns # string [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < ConfigMap > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ConfigMap"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#class-configmap","text":"Main . K8sApi .ConfigMap","title":"Class: ConfigMap"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , void > \u21b3 ConfigMap","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#properties","text":"apiVersion binaryData data immutable kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#constructor","text":"\u2022 new ConfigMap ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#binarydata","text":"\u2022 binaryData : Partial < Record < string , string >>","title":"binaryData"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#data","text":"\u2022 data : Partial < Record < string , string >>","title":"data"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#immutable","text":"\u2022 Optional immutable : boolean","title":"immutable"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getkeys","text":"\u25b8 getKeys (): string []","title":"getKeys"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/","text":"Class: CronJob # Main . K8sApi .CronJob Hierarchy # KubeObject < NamespaceScopedMetadata , CronJobStatus , CronJobSpec > \u21b3 CronJob Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getLastScheduleTime getName getNs getOwnerRefs getResourceVersion getSchedule getScopedName getSearchFields getSuspendFlag getTimeDiffFromNow isNeverRun isSuspend patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new CronJob ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , CronJobStatus , CronJobSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : CronJobSpec Inherited from # KubeObject . spec status # \u2022 Optional status : CronJobStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/batch/v1/cronjobs\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"CronJob\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLastScheduleTime # \u25b8 getLastScheduleTime (): string Returns # string getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSchedule # \u25b8 getSchedule (): string Returns # string getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSuspendFlag # \u25b8 getSuspendFlag (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow isNeverRun # \u25b8 isNeverRun (): boolean Returns # boolean isSuspend # \u25b8 isSuspend (): undefined | boolean Returns # undefined | boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < CronJob > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: CronJob"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#class-cronjob","text":"Main . K8sApi .CronJob","title":"Class: CronJob"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , CronJobStatus , CronJobSpec > \u21b3 CronJob","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getLastScheduleTime getName getNs getOwnerRefs getResourceVersion getSchedule getScopedName getSearchFields getSuspendFlag getTimeDiffFromNow isNeverRun isSuspend patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#constructor","text":"\u2022 new CronJob ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#spec","text":"\u2022 spec : CronJobSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#status","text":"\u2022 Optional status : CronJobStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/batch/v1/cronjobs\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#kind_1","text":"\u25aa Static Readonly kind : \"CronJob\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getlastscheduletime","text":"\u25b8 getLastScheduleTime (): string","title":"getLastScheduleTime"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getschedule","text":"\u25b8 getSchedule (): string","title":"getSchedule"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getsuspendflag","text":"\u25b8 getSuspendFlag (): string","title":"getSuspendFlag"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isneverrun","text":"\u25b8 isNeverRun (): boolean","title":"isNeverRun"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#issuspend","text":"\u25b8 isSuspend (): undefined | boolean","title":"isSuspend"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/","text":"Class: CustomResourceDefinition # Main . K8sApi .CustomResourceDefinition Hierarchy # KubeObject < ClusterScopedMetadata , CustomResourceDefinitionStatus , CustomResourceDefinitionSpec > \u21b3 CustomResourceDefinition Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getConditions getConversion getCreationTimestamp getFinalizers getGroup getId getLabels getName getNames getNs getOwnerRefs getPluralName getPreferedVersion getPrinterColumns getResourceApiBase getResourceKind getResourceTitle getResourceUrl getResourceVersion getScope getScopedName getSearchFields getStoredVersions getTimeDiffFromNow getValidation getVersion isNamespaced patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new CustomResourceDefinition ( data ) Parameters # Name Type data KubeJsonApiData < ClusterScopedMetadata , CustomResourceDefinitionStatus , CustomResourceDefinitionSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : CustomResourceDefinitionSpec Inherited from # KubeObject . spec status # \u2022 Optional status : CustomResourceDefinitionStatus Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getConditions # \u25b8 getConditions (): { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] Returns # { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] getConversion # \u25b8 getConversion (): string Returns # string getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getGroup # \u25b8 getGroup (): string Returns # string getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNames # \u25b8 getNames (): CustomResourceDefinitionNames Returns # CustomResourceDefinitionNames getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPluralName # \u25b8 getPluralName (): string Returns # string getPreferedVersion # \u25b8 getPreferedVersion (): CustomResourceDefinitionVersion Returns # CustomResourceDefinitionVersion getPrinterColumns # \u25b8 getPrinterColumns ( ignorePriority? ): AdditionalPrinterColumnsV1 [] Parameters # Name Type ignorePriority? boolean Returns # AdditionalPrinterColumnsV1 [] getResourceApiBase # \u25b8 getResourceApiBase (): string Returns # string getResourceKind # \u25b8 getResourceKind (): string Returns # string getResourceTitle # \u25b8 getResourceTitle (): string Returns # string getResourceUrl # \u25b8 getResourceUrl (): string Returns # string getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScope # \u25b8 getScope (): \"Cluster\" | \"Namespaced\" Returns # \"Cluster\" | \"Namespaced\" getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getStoredVersions # \u25b8 getStoredVersions (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getValidation # \u25b8 getValidation (): string Returns # string getVersion # \u25b8 getVersion (): string Returns # string isNamespaced # \u25b8 isNamespaced (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < CustomResourceDefinition > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: CustomResourceDefinition"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#class-customresourcedefinition","text":"Main . K8sApi .CustomResourceDefinition","title":"Class: CustomResourceDefinition"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#hierarchy","text":"KubeObject < ClusterScopedMetadata , CustomResourceDefinitionStatus , CustomResourceDefinitionSpec > \u21b3 CustomResourceDefinition","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#methods","text":"delete getAge getAnnotations getConditions getConversion getCreationTimestamp getFinalizers getGroup getId getLabels getName getNames getNs getOwnerRefs getPluralName getPreferedVersion getPrinterColumns getResourceApiBase getResourceKind getResourceTitle getResourceUrl getResourceVersion getScope getScopedName getSearchFields getStoredVersions getTimeDiffFromNow getValidation getVersion isNamespaced patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#constructor","text":"\u2022 new CustomResourceDefinition ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#spec","text":"\u2022 spec : CustomResourceDefinitionSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#status","text":"\u2022 Optional status : CustomResourceDefinitionStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getconditions","text":"\u25b8 getConditions (): { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[]","title":"getConditions"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getconversion","text":"\u25b8 getConversion (): string","title":"getConversion"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getgroup","text":"\u25b8 getGroup (): string","title":"getGroup"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getnames","text":"\u25b8 getNames (): CustomResourceDefinitionNames","title":"getNames"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getpluralname","text":"\u25b8 getPluralName (): string","title":"getPluralName"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getpreferedversion","text":"\u25b8 getPreferedVersion (): CustomResourceDefinitionVersion","title":"getPreferedVersion"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getprintercolumns","text":"\u25b8 getPrinterColumns ( ignorePriority? ): AdditionalPrinterColumnsV1 []","title":"getPrinterColumns"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourceapibase","text":"\u25b8 getResourceApiBase (): string","title":"getResourceApiBase"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourcekind","text":"\u25b8 getResourceKind (): string","title":"getResourceKind"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourcetitle","text":"\u25b8 getResourceTitle (): string","title":"getResourceTitle"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourceurl","text":"\u25b8 getResourceUrl (): string","title":"getResourceUrl"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getscope","text":"\u25b8 getScope (): \"Cluster\" | \"Namespaced\"","title":"getScope"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getstoredversions","text":"\u25b8 getStoredVersions (): string","title":"getStoredVersions"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getvalidation","text":"\u25b8 getValidation (): string","title":"getValidation"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getversion","text":"\u25b8 getVersion (): string","title":"getVersion"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isnamespaced","text":"\u25b8 isNamespaced (): boolean","title":"isNamespaced"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/","text":"Class: DaemonSet # Main . K8sApi .DaemonSet Hierarchy # KubeObject < NamespaceScopedMetadata , DaemonSetStatus , DaemonSetSpec > \u21b3 DaemonSet Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getCreationTimestamp getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new DaemonSet ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , DaemonSetStatus , DaemonSetSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : DaemonSetSpec Inherited from # KubeObject . spec status # \u2022 Optional status : DaemonSetStatus Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAffinity # \u25b8 getAffinity (): undefined | Affinity Returns # undefined | Affinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getImages # \u25b8 getImages (): ( undefined | string )[] Returns # ( undefined | string )[] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): Toleration [] Returns # Toleration [] patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < DaemonSet > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: DaemonSet"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#class-daemonset","text":"Main . K8sApi .DaemonSet","title":"Class: DaemonSet"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , DaemonSetStatus , DaemonSetSpec > \u21b3 DaemonSet","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getCreationTimestamp getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#constructor","text":"\u2022 new DaemonSet ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#spec","text":"\u2022 spec : DaemonSetSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#status","text":"\u2022 Optional status : DaemonSetStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getaffinity","text":"\u25b8 getAffinity (): undefined | Affinity","title":"getAffinity"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getimages","text":"\u25b8 getImages (): ( undefined | string )[]","title":"getImages"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#gettolerations","text":"\u25b8 getTolerations (): Toleration []","title":"getTolerations"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/","text":"Class: Deployment # Main . K8sApi .Deployment Hierarchy # KubeObject < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec > \u21b3 Deployment Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getConditions getConditionsText getCreationTimestamp getFinalizers getId getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Deployment ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : DeploymentSpec Inherited from # KubeObject . spec status # \u2022 Optional status : DeploymentStatus Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAffinity # \u25b8 getAffinity (): undefined | Affinity Returns # undefined | Affinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getConditions # \u25b8 getConditions ( activeOnly? ): BaseKubeObjectCondition [] Parameters # Name Type activeOnly? boolean Returns # BaseKubeObjectCondition [] getConditionsText # \u25b8 getConditionsText ( activeOnly? ): string Parameters # Name Type activeOnly? boolean Returns # string getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getReplicas # \u25b8 getReplicas (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): Toleration [] Returns # Toleration [] patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Deployment > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Deployment"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#class-deployment","text":"Main . K8sApi .Deployment","title":"Class: Deployment"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec > \u21b3 Deployment","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getConditions getConditionsText getCreationTimestamp getFinalizers getId getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#constructor","text":"\u2022 new Deployment ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#spec","text":"\u2022 spec : DeploymentSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#status","text":"\u2022 Optional status : DeploymentStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getaffinity","text":"\u25b8 getAffinity (): undefined | Affinity","title":"getAffinity"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getconditions","text":"\u25b8 getConditions ( activeOnly? ): BaseKubeObjectCondition []","title":"getConditions"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getconditionstext","text":"\u25b8 getConditionsText ( activeOnly? ): string","title":"getConditionsText"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getreplicas","text":"\u25b8 getReplicas (): number","title":"getReplicas"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#gettolerations","text":"\u25b8 getTolerations (): Toleration []","title":"getTolerations"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/","text":"Class: Endpoint # Main . K8sApi .Endpoint Hierarchy # KubeObject < NamespaceScopedMetadata , void , void > \u21b3 Endpoint Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status subsets apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getEndpointSubsets getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject toString update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Endpoint ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb EndpointsData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status subsets # \u2022 Optional subsets : EndpointSubset [] apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getEndpointSubsets # \u25b8 getEndpointSubsets (): Required < EndpointSubset >[] Returns # Required < EndpointSubset >[] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject toString # \u25b8 toString (): string Returns # string update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Endpoint > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Endpoint"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#class-endpoint","text":"Main . K8sApi .Endpoint","title":"Class: Endpoint"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , void > \u21b3 Endpoint","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#properties","text":"apiVersion kind metadata spec status subsets apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#methods","text":"delete getAge getAnnotations getCreationTimestamp getEndpointSubsets getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject toString update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#constructor","text":"\u2022 new Endpoint ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#subsets","text":"\u2022 Optional subsets : EndpointSubset []","title":"subsets"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getendpointsubsets","text":"\u25b8 getEndpointSubsets (): Required < EndpointSubset >[]","title":"getEndpointSubsets"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#tostring","text":"\u25b8 toString (): string","title":"toString"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/","text":"Class: HorizontalPodAutoscaler # Main . K8sApi .HorizontalPodAutoscaler Hierarchy # KubeObject < NamespaceScopedMetadata , HorizontalPodAutoscalerStatus , HorizontalPodAutoscalerSpec > \u21b3 HorizontalPodAutoscaler Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getConditions getCreationTimestamp getCurrentMetrics getFinalizers getId getLabels getMaxPods getMetrics getMinPods getName getNs getOwnerRefs getReadyConditions getReplicas getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new HorizontalPodAutoscaler ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , HorizontalPodAutoscalerStatus , HorizontalPodAutoscalerSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : HorizontalPodAutoscalerSpec Inherited from # KubeObject . spec status # \u2022 Optional status : HorizontalPodAutoscalerStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/autoscaling/v2/horizontalpodautoscalers\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"HorizontalPodAutoscaler\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getConditions # \u25b8 getConditions (): { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] Returns # { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getCurrentMetrics # \u25b8 getCurrentMetrics (): HorizontalPodAutoscalerMetricStatus [] Returns # HorizontalPodAutoscalerMetricStatus [] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMaxPods # \u25b8 getMaxPods (): number Returns # number getMetrics # \u25b8 getMetrics (): HorizontalPodAutoscalerMetricSpec [] Returns # HorizontalPodAutoscalerMetricSpec [] getMinPods # \u25b8 getMinPods (): number Returns # number getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getReadyConditions # \u25b8 getReadyConditions (): { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] Returns # { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] getReplicas # \u25b8 getReplicas (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < HorizontalPodAutoscaler > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#class-horizontalpodautoscaler","text":"Main . K8sApi .HorizontalPodAutoscaler","title":"Class: HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , HorizontalPodAutoscalerStatus , HorizontalPodAutoscalerSpec > \u21b3 HorizontalPodAutoscaler","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#methods","text":"delete getAge getAnnotations getConditions getCreationTimestamp getCurrentMetrics getFinalizers getId getLabels getMaxPods getMetrics getMinPods getName getNs getOwnerRefs getReadyConditions getReplicas getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#constructor","text":"\u2022 new HorizontalPodAutoscaler ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#spec","text":"\u2022 spec : HorizontalPodAutoscalerSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#status","text":"\u2022 Optional status : HorizontalPodAutoscalerStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/autoscaling/v2/horizontalpodautoscalers\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#kind_1","text":"\u25aa Static Readonly kind : \"HorizontalPodAutoscaler\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getconditions","text":"\u25b8 getConditions (): { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[]","title":"getConditions"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getcurrentmetrics","text":"\u25b8 getCurrentMetrics (): HorizontalPodAutoscalerMetricStatus []","title":"getCurrentMetrics"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getmaxpods","text":"\u25b8 getMaxPods (): number","title":"getMaxPods"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getmetrics","text":"\u25b8 getMetrics (): HorizontalPodAutoscalerMetricSpec []","title":"getMetrics"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getminpods","text":"\u25b8 getMinPods (): number","title":"getMinPods"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getreadyconditions","text":"\u25b8 getReadyConditions (): { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[]","title":"getReadyConditions"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getreplicas","text":"\u25b8 getReplicas (): number","title":"getReplicas"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/","text":"Class: Ingress # Main . K8sApi .Ingress Hierarchy # KubeObject < NamespaceScopedMetadata , IngressStatus , IngressSpec > \u21b3 Ingress Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getHosts getId getLabels getLoadBalancers getName getNs getOwnerRefs getPorts getResourceVersion getRoutes getRules getScopedName getSearchFields getServiceNamePort getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Ingress ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , IngressStatus , IngressSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : IngressSpec Inherited from # KubeObject . spec status # \u2022 Optional status : IngressStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/networking.k8s.io/v1/ingresses\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Ingress\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getHosts # \u25b8 getHosts (): string [] Returns # string [] getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLoadBalancers # \u25b8 getLoadBalancers (): ( undefined | string )[] Returns # ( undefined | string )[] getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPorts # \u25b8 getPorts (): string Returns # string getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRoutes # \u25b8 getRoutes (): string [] Returns # string [] getRules # \u25b8 getRules (): IngressRule [] Returns # IngressRule [] getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getServiceNamePort # \u25b8 getServiceNamePort (): undefined | ExtensionsBackend Returns # undefined | ExtensionsBackend getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Ingress > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Ingress"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#class-ingress","text":"Main . K8sApi .Ingress","title":"Class: Ingress"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , IngressStatus , IngressSpec > \u21b3 Ingress","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getHosts getId getLabels getLoadBalancers getName getNs getOwnerRefs getPorts getResourceVersion getRoutes getRules getScopedName getSearchFields getServiceNamePort getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#constructor","text":"\u2022 new Ingress ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#spec","text":"\u2022 spec : IngressSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#status","text":"\u2022 Optional status : IngressStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/networking.k8s.io/v1/ingresses\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#kind_1","text":"\u25aa Static Readonly kind : \"Ingress\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#gethosts","text":"\u25b8 getHosts (): string []","title":"getHosts"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getloadbalancers","text":"\u25b8 getLoadBalancers (): ( undefined | string )[]","title":"getLoadBalancers"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getports","text":"\u25b8 getPorts (): string","title":"getPorts"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getroutes","text":"\u25b8 getRoutes (): string []","title":"getRoutes"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getrules","text":"\u25b8 getRules (): IngressRule []","title":"getRules"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getservicenameport","text":"\u25b8 getServiceNamePort (): undefined | ExtensionsBackend","title":"getServiceNamePort"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Job/","text":"Class: Job # Main . K8sApi .Job Hierarchy # KubeObject < NamespaceScopedMetadata , JobStatus , JobSpec > \u21b3 Job Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getCompletions getCondition getCreationTimestamp getDesiredCompletions getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getParallelism getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Job ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , JobStatus , JobSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : JobSpec Inherited from # KubeObject . spec status # \u2022 Optional status : JobStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/batch/v1/jobs\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Job\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAffinity # \u25b8 getAffinity (): undefined | Affinity Returns # undefined | Affinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCompletions # \u25b8 getCompletions (): number Returns # number getCondition # \u25b8 getCondition (): undefined | BaseKubeObjectCondition Returns # undefined | BaseKubeObjectCondition getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getDesiredCompletions # \u25b8 getDesiredCompletions (): number Returns # number getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getImages # \u25b8 getImages (): ( undefined | string )[] Returns # ( undefined | string )[] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getParallelism # \u25b8 getParallelism (): undefined | number Returns # undefined | number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): Toleration [] Returns # Toleration [] patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Job > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Job"},{"location":"extensions/api/classes/Main.K8sApi.Job/#class-job","text":"Main . K8sApi .Job","title":"Class: Job"},{"location":"extensions/api/classes/Main.K8sApi.Job/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , JobStatus , JobSpec > \u21b3 Job","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Job/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Job/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Job/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Job/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Job/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getCompletions getCondition getCreationTimestamp getDesiredCompletions getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getParallelism getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Job/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Job/#constructor","text":"\u2022 new Job ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Job/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Job/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Job/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Job/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Job/#spec","text":"\u2022 spec : JobSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Job/#status","text":"\u2022 Optional status : JobStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Job/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/batch/v1/jobs\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Job/#kind_1","text":"\u25aa Static Readonly kind : \"Job\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Job/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Job/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Job/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Job/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Job/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getaffinity","text":"\u25b8 getAffinity (): undefined | Affinity","title":"getAffinity"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/Main.K8sApi.Job/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getcompletions","text":"\u25b8 getCompletions (): number","title":"getCompletions"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getcondition","text":"\u25b8 getCondition (): undefined | BaseKubeObjectCondition","title":"getCondition"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getdesiredcompletions","text":"\u25b8 getDesiredCompletions (): number","title":"getDesiredCompletions"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getimages","text":"\u25b8 getImages (): ( undefined | string )[]","title":"getImages"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getparallelism","text":"\u25b8 getParallelism (): undefined | number","title":"getParallelism"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/Main.K8sApi.Job/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/Main.K8sApi.Job/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Job/#gettolerations","text":"\u25b8 getTolerations (): Toleration []","title":"getTolerations"},{"location":"extensions/api/classes/Main.K8sApi.Job/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Job/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Job/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Job/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Job/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Job/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Job/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Job/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Job/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Job/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Job/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Job/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/","text":"Class: KubeEvent # Main . K8sApi .KubeEvent Hierarchy # KubeObject < KubeObjectMetadata < KubeObjectScope.Namespace >, void , void > \u21b3 KubeEvent Table of contents # Constructors # constructor Properties # action apiVersion count eventTime firstTimestamp involvedObject kind lastTimestamp message metadata reason related reportingComponent reportingInstance series source spec status type apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getFirstSeenTime getId getLabels getLastSeenTime getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSource getTimeDiffFromNow isWarning patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new KubeEvent ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb KubeEventData Overrides # KubeObject . constructor Properties # action # \u2022 Optional action : string apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion count # \u2022 Optional count : number eventTime # \u2022 Optional eventTime : string firstTimestamp # \u2022 Optional firstTimestamp : string involvedObject # \u2022 involvedObject : Required < ObjectReference > kind # \u2022 kind : string Inherited from # KubeObject . kind lastTimestamp # \u2022 Optional lastTimestamp : string message # \u2022 Optional message : string metadata # \u2022 metadata : KubeObjectMetadata < Namespace > Inherited from # KubeObject . metadata reason # \u2022 Optional reason : string related # \u2022 Optional related : ObjectReference reportingComponent # \u2022 Optional reportingComponent : string reportingInstance # \u2022 Optional reportingInstance : string series # \u2022 Optional series : EventSeries source # \u2022 Optional source : EventSource spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status type # \u2022 Optional type : string Current supported values are: - \"Normal\" - \"Warning\" apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getFirstSeenTime # \u25b8 getFirstSeenTime (): string Deprecated This function is not reactive to changing of time. If rendering use instead Returns # string getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLastSeenTime # \u25b8 getLastSeenTime (): string Deprecated This function is not reactive to changing of time. If rendering use instead Returns # string getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSource # \u25b8 getSource (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow isWarning # \u25b8 isWarning (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < KubeEvent > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: KubeEvent"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#class-kubeevent","text":"Main . K8sApi .KubeEvent","title":"Class: KubeEvent"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#hierarchy","text":"KubeObject < KubeObjectMetadata < KubeObjectScope.Namespace >, void , void > \u21b3 KubeEvent","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#properties","text":"action apiVersion count eventTime firstTimestamp involvedObject kind lastTimestamp message metadata reason related reportingComponent reportingInstance series source spec status type apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getFirstSeenTime getId getLabels getLastSeenTime getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSource getTimeDiffFromNow isWarning patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#constructor","text":"\u2022 new KubeEvent ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#action","text":"\u2022 Optional action : string","title":"action"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#count","text":"\u2022 Optional count : number","title":"count"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#eventtime","text":"\u2022 Optional eventTime : string","title":"eventTime"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#firsttimestamp","text":"\u2022 Optional firstTimestamp : string","title":"firstTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#involvedobject","text":"\u2022 involvedObject : Required < ObjectReference >","title":"involvedObject"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#lasttimestamp","text":"\u2022 Optional lastTimestamp : string","title":"lastTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#message","text":"\u2022 Optional message : string","title":"message"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#metadata","text":"\u2022 metadata : KubeObjectMetadata < Namespace >","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#reason","text":"\u2022 Optional reason : string","title":"reason"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#related","text":"\u2022 Optional related : ObjectReference","title":"related"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#reportingcomponent","text":"\u2022 Optional reportingComponent : string","title":"reportingComponent"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#reportinginstance","text":"\u2022 Optional reportingInstance : string","title":"reportingInstance"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#series","text":"\u2022 Optional series : EventSeries","title":"series"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#source","text":"\u2022 Optional source : EventSource","title":"source"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type","text":"\u2022 Optional type : string Current supported values are: - \"Normal\" - \"Warning\"","title":"type"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getfirstseentime","text":"\u25b8 getFirstSeenTime (): string Deprecated This function is not reactive to changing of time. If rendering use instead","title":"getFirstSeenTime"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getlastseentime","text":"\u25b8 getLastSeenTime (): string Deprecated This function is not reactive to changing of time. If rendering use instead","title":"getLastSeenTime"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getsource","text":"\u25b8 getSource (): string","title":"getSource"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#iswarning","text":"\u25b8 isWarning (): boolean","title":"isWarning"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/","text":"Class: KubeObject # Main . K8sApi .KubeObject Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Hierarchy # 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 Implements # ItemObject Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new KubeObject < Metadata , Status , Spec >( data ) Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Properties # apiVersion # \u2022 apiVersion : string kind # \u2022 kind : string metadata # \u2022 metadata : Metadata spec # \u2022 spec : Spec status # \u2022 Optional status : Status apiBase # \u25aa Static Optional Readonly apiBase : string kind # \u25aa Static Optional Readonly kind : string namespaced # \u25aa Static Optional Readonly namespaced : boolean Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] getId # \u25b8 getId (): string Returns # string Implementation of # ItemObject.getId getLabels # \u25b8 getLabels (): string [] Returns # string [] getName # \u25b8 getName (): string Returns # string Implementation of # ItemObject.getName getNs # \u25b8 getNs (): Metadata [ \"namespace\" ] Returns # Metadata [ \"namespace\" ] getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : Metadata [ \"namespace\" ] ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : Metadata [ \"namespace\" ] ; uid : string }[] getResourceVersion # \u25b8 getResourceVersion (): string Returns # string getScopedName # \u25b8 getScopedName (): string Returns # string getSearchFields # \u25b8 getSearchFields (): ( string | Metadata [ \"namespace\" ])[] Returns # ( string | Metadata [ \"namespace\" ])[] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < KubeObject < Metadata , Status , Spec >> Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string []","title":"Class: KubeObject"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#class-kubeobjectmetadata-status-spec","text":"Main . K8sApi .KubeObject","title":"Class: KubeObject<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-parameters","text":"Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown","title":"Type parameters"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#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","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#implements","text":"ItemObject","title":"Implements"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#constructor","text":"\u2022 new KubeObject < Metadata , Status , Spec >( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#spec","text":"\u2022 spec : Spec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#status","text":"\u2022 Optional status : Status","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#apibase","text":"\u25aa Static Optional Readonly apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#kind_1","text":"\u25aa Static Optional Readonly kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#namespaced","text":"\u25aa Static Optional Readonly namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getns","text":"\u25b8 getNs (): Metadata [ \"namespace\" ]","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : Metadata [ \"namespace\" ] ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getsearchfields","text":"\u25b8 getSearchFields (): ( string | Metadata [ \"namespace\" ])[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/","text":"Class: KubeObjectStore # Main . K8sApi .KubeObjectStore Type parameters # Name Type K extends KubeObject = KubeObject A extends InternalKubeApi < K , D > = InternalKubeApi < K , KubeJsonApiDataFor < K >> D extends KubeJsonApiDataFor < K > = KubeApiDataFrom < K , A > Hierarchy # KubeObjectStore < K , A , D > \u21b3 KubeObjectStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds context Accessors # context contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new KubeObjectStore < K , A , D >( api , opts? ) Type parameters # Name Type 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 > Parameters # Name Type api A opts? KubeObjectStoreOptions Overrides # InternalKubeObjectStore.constructor \u2022 new KubeObjectStore < K , A , D >() Deprecated Supply API instance through constructor Type parameters # Name Type 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 > Overrides # InternalKubeObjectStore.constructor Properties # api # \u2022 Readonly api : A Inherited from # InternalKubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # InternalKubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : K ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item K Returns # string Inherited from # InternalKubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # InternalKubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < D >> Inherited from # InternalKubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # InternalKubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # InternalKubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # InternalKubeObjectStore.isLoading items # \u2022 items : IObservableArray < K > Inherited from # InternalKubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # InternalKubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # InternalKubeObjectStore.selectedItemsIds context # \u25aa Static Readonly context : Object Deprecated This is no longer used and shouldn't have been every really used Type declaration # Name Type get () => ClusterContext set ( ctx : ClusterContext ) => void Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # InternalKubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # InternalKubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # InternalKubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < K , void , undefined > Returns # Generator < K , void , undefined > Inherited from # InternalKubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # InternalKubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string data? PartialDeep < K > Returns # Promise < K > Inherited from # InternalKubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | K > Parameters # Name Type params Object params.name string params.namespace? string data? PartialDeep < K > Returns # Promise < null | K > Inherited from # InternalKubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): K [] Parameters # Name Type items K [] Returns # K [] Inherited from # InternalKubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): K [] Parameters # Name Type namespace string | string [] strict? boolean Returns # K [] Inherited from # InternalKubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | K Parameters # Name Type id string Returns # undefined | K Inherited from # InternalKubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): K [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # K [] Inherited from # InternalKubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | K Parameters # Name Type name string namespace? string Returns # undefined | K Inherited from # InternalKubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | K Parameters # Name Type path string Returns # undefined | K Inherited from # InternalKubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # InternalKubeObjectStore.getIndexById getItems # \u25b8 getItems (): K [] Returns # K [] Inherited from # InternalKubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # InternalKubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item K Returns # boolean Inherited from # InternalKubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? K [] Returns # boolean Inherited from # InternalKubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < K > Inherited from # InternalKubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | K []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | K []> Inherited from # InternalKubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < K > Parameters # Name Type resourcePath string Returns # Promise < K > Inherited from # InternalKubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | K > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | K > Inherited from # InternalKubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < K []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < K []> Inherited from # InternalKubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): K [] Parameters # Name Type partialItems K [] \u00abdestructured\u00bb MergeItemsOptions Returns # K [] Inherited from # InternalKubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < K > Parameters # Name Type item K patch Patch Returns # Promise < K > Inherited from # InternalKubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): K [] Parameters # Name Type items K [] Returns # K [] Inherited from # InternalKubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | K []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | K []> Inherited from # InternalKubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item K Returns # Promise < void > Inherited from # InternalKubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item K request () => Promise < any > Returns # Promise < void > Inherited from # InternalKubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items K [] Returns # Promise < void > Inherited from # InternalKubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # InternalKubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # InternalKubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # InternalKubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # InternalKubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item K Returns # void Inherited from # InternalKubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # K [] Inherited from # InternalKubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # InternalKubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item K Returns # void Inherited from # InternalKubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? K [] Returns # void Inherited from # InternalKubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item K Returns # void Inherited from # InternalKubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < K > Parameters # Name Type item K data PartialDeep < K > Returns # Promise < K > Inherited from # InternalKubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # InternalKubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < K > Parameters # Name Type item K request () => Promise < K > Returns # Promise < K > Inherited from # InternalKubeObjectStore.updateItem","title":"Class: KubeObjectStore"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#class-kubeobjectstorek-a-d","text":"Main . K8sApi .KubeObjectStore","title":"Class: KubeObjectStore<K, A, D>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#type-parameters","text":"Name Type K extends KubeObject = KubeObject A extends InternalKubeApi < K , D > = InternalKubeApi < K , KubeJsonApiDataFor < K >> D extends KubeJsonApiDataFor < K > = KubeApiDataFrom < K , A >","title":"Type parameters"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#hierarchy","text":"KubeObjectStore < K , A , D > \u21b3 KubeObjectStore","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds context","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#accessors","text":"context contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#constructor","text":"\u2022 new KubeObjectStore < K , A , D >( api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#api","text":"\u2022 Readonly api : A","title":"api"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : K ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < D >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#items","text":"\u2022 items : IObservableArray < K >","title":"items"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#context","text":"\u25aa Static Readonly context : Object Deprecated This is no longer used and shouldn't have been every really used","title":"context"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#context_1","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#iterator","text":"\u25b8 [iterator] (): Generator < K , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#create","text":"\u25b8 create ( params , data? ): Promise < K >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | K >","title":"createItem"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): K []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): K []","title":"getAllByNs"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbyid","text":"\u25b8 getById ( id ): undefined | K","title":"getById"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): K []","title":"getByLabel"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | K","title":"getByName"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | K","title":"getByPath"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getitems","text":"\u25b8 getItems (): K []","title":"getItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#load","text":"\u25b8 load ( params ): Promise < K >","title":"load"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | K []>","title":"loadAll"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < K >","title":"loadFromPath"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | K >","title":"loadItem"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < K []>","title":"loadItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): K []","title":"mergeItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < K >","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): K []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | K []>","title":"reloadAll"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#update","text":"\u25b8 update ( item , data ): Promise < K >","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < K >","title":"updateItem"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/","text":"Class: KubeStatus # Main . K8sApi .KubeStatus Table of contents # Constructors # constructor Properties # apiVersion code kind message reason Constructors # constructor # \u2022 new KubeStatus ( data ) Parameters # Name Type data KubeStatusData Properties # apiVersion # \u2022 Readonly apiVersion : string code # \u2022 Readonly code : number kind # \u2022 Readonly kind : \"Status\" message # \u2022 Readonly message : string reason # \u2022 Readonly reason : string","title":"Class: KubeStatus"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#class-kubestatus","text":"Main . K8sApi .KubeStatus","title":"Class: KubeStatus"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#properties","text":"apiVersion code kind message reason","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#constructor","text":"\u2022 new KubeStatus ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#apiversion","text":"\u2022 Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#code","text":"\u2022 Readonly code : number","title":"code"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#kind","text":"\u2022 Readonly kind : \"Status\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#message","text":"\u2022 Readonly message : string","title":"message"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#reason","text":"\u2022 Readonly reason : string","title":"reason"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/","text":"Class: LimitRange # Main . K8sApi .LimitRange Hierarchy # KubeObject < NamespaceScopedMetadata , void , LimitRangeSpec > \u21b3 LimitRange Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getContainerLimits getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getPVCLimits getPodLimits getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new LimitRange ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , void , LimitRangeSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : LimitRangeSpec Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/api/v1/limitranges\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"LimitRange\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getContainerLimits # \u25b8 getContainerLimits (): LimitRangeItem [] Returns # LimitRangeItem [] getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPVCLimits # \u25b8 getPVCLimits (): LimitRangeItem [] Returns # LimitRangeItem [] getPodLimits # \u25b8 getPodLimits (): LimitRangeItem [] Returns # LimitRangeItem [] getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < LimitRange > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: LimitRange"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#class-limitrange","text":"Main . K8sApi .LimitRange","title":"Class: LimitRange"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , LimitRangeSpec > \u21b3 LimitRange","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#methods","text":"delete getAge getAnnotations getContainerLimits getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getPVCLimits getPodLimits getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#constructor","text":"\u2022 new LimitRange ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#spec","text":"\u2022 spec : LimitRangeSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/limitranges\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#kind_1","text":"\u25aa Static Readonly kind : \"LimitRange\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getcontainerlimits","text":"\u25b8 getContainerLimits (): LimitRangeItem []","title":"getContainerLimits"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getpvclimits","text":"\u25b8 getPVCLimits (): LimitRangeItem []","title":"getPVCLimits"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getpodlimits","text":"\u25b8 getPodLimits (): LimitRangeItem []","title":"getPodLimits"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/","text":"Class: Namespace # Main . K8sApi .Namespace Hierarchy # KubeObject < ClusterScopedMetadata , NamespaceStatus , NamespaceSpec > \u21b3 Namespace Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getStatus getTimeDiffFromNow isChildOf isControlledByHNC isSubnamespace patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Namespace ( data ) Parameters # Name Type data KubeJsonApiData < ClusterScopedMetadata , NamespaceStatus , NamespaceSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : NamespaceSpec Inherited from # KubeObject . spec status # \u2022 Optional status : NamespaceStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/api/v1/namespaces\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Namespace\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : false Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getStatus # \u25b8 getStatus (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow isChildOf # \u25b8 isChildOf ( parentName ): undefined | string Parameters # Name Type parentName string Returns # undefined | string isControlledByHNC # \u25b8 isControlledByHNC (): undefined | string Returns # undefined | string isSubnamespace # \u25b8 isSubnamespace (): undefined | string Returns # undefined | string patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Namespace > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Namespace"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#class-namespace","text":"Main . K8sApi .Namespace","title":"Class: Namespace"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#hierarchy","text":"KubeObject < ClusterScopedMetadata , NamespaceStatus , NamespaceSpec > \u21b3 Namespace","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getStatus getTimeDiffFromNow isChildOf isControlledByHNC isSubnamespace patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#constructor","text":"\u2022 new Namespace ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#spec","text":"\u2022 spec : NamespaceSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#status","text":"\u2022 Optional status : NamespaceStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/namespaces\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#kind_1","text":"\u25aa Static Readonly kind : \"Namespace\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#namespaced","text":"\u25aa Static Readonly namespaced : false","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getstatus","text":"\u25b8 getStatus (): string","title":"getStatus"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#ischildof","text":"\u25b8 isChildOf ( parentName ): undefined | string","title":"isChildOf"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#iscontrolledbyhnc","text":"\u25b8 isControlledByHNC (): undefined | string","title":"isControlledByHNC"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#issubnamespace","text":"\u25b8 isSubnamespace (): undefined | string","title":"isSubnamespace"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/","text":"Class: NetworkPolicy # Main . K8sApi .NetworkPolicy Hierarchy # KubeObject < NamespaceScopedMetadata , void , NetworkPolicySpec > \u21b3 NetworkPolicy Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getMatchLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getTypes patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new NetworkPolicy ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , void , NetworkPolicySpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : NetworkPolicySpec Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/networking.k8s.io/v1/networkpolicies\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"NetworkPolicy\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMatchLabels # \u25b8 getMatchLabels (): string [] Returns # string [] getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTypes # \u25b8 getTypes (): string [] Returns # string [] patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < NetworkPolicy > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: NetworkPolicy"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#class-networkpolicy","text":"Main . K8sApi .NetworkPolicy","title":"Class: NetworkPolicy"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , NetworkPolicySpec > \u21b3 NetworkPolicy","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getMatchLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getTypes patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#constructor","text":"\u2022 new NetworkPolicy ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#spec","text":"\u2022 spec : NetworkPolicySpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/networking.k8s.io/v1/networkpolicies\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#kind_1","text":"\u25aa Static Readonly kind : \"NetworkPolicy\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getmatchlabels","text":"\u25b8 getMatchLabels (): string []","title":"getMatchLabels"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#gettypes","text":"\u25b8 getTypes (): string []","title":"getTypes"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Node/","text":"Class: Node # Main . K8sApi .Node Hierarchy # KubeObject < ClusterScopedMetadata , NodeStatus , NodeSpec > \u21b3 Node Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getActiveConditions getAge getAnnotations getConditions getCpuCapacity getCreationTimestamp getFinalizers getId getKubeletVersion getLabels getMemoryCapacity getName getNodeConditionText getNs getOperatingSystem getOwnerRefs getResourceVersion getRoleLabelItems getRoleLabels getScopedName getSearchFields getTaints getTimeDiffFromNow getWarningConditions isMasterNode isUnschedulable patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Node ( data ) Parameters # Name Type data KubeJsonApiData < ClusterScopedMetadata , NodeStatus , NodeSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : NodeSpec Inherited from # KubeObject . spec status # \u2022 Optional status : NodeStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/api/v1/nodes\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Node\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : false Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getActiveConditions # \u25b8 getActiveConditions (): NodeCondition [] Returns # NodeCondition [] getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getConditions # \u25b8 getConditions (): NodeCondition [] Returns # NodeCondition [] getCpuCapacity # \u25b8 getCpuCapacity (): undefined | number Returns # undefined | number getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getKubeletVersion # \u25b8 getKubeletVersion (): string Returns # string getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMemoryCapacity # \u25b8 getMemoryCapacity (): number Returns # number getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeConditionText # \u25b8 getNodeConditionText (): string Returns the concatination of all current condition types which have a status of \"True\" Returns # string getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOperatingSystem # \u25b8 getOperatingSystem (): string Returns # string getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRoleLabelItems # \u25b8 getRoleLabelItems (): string [] Returns # string [] getRoleLabels # \u25b8 getRoleLabels (): string Returns # string getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getTaints # \u25b8 getTaints (): NodeTaint [] Returns # NodeTaint [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getWarningConditions # \u25b8 getWarningConditions (): NodeCondition [] Returns # NodeCondition [] isMasterNode # \u25b8 isMasterNode (): boolean Returns # boolean isUnschedulable # \u25b8 isUnschedulable (): undefined | boolean Returns # undefined | boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Node > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Node"},{"location":"extensions/api/classes/Main.K8sApi.Node/#class-node","text":"Main . K8sApi .Node","title":"Class: Node"},{"location":"extensions/api/classes/Main.K8sApi.Node/#hierarchy","text":"KubeObject < ClusterScopedMetadata , NodeStatus , NodeSpec > \u21b3 Node","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Node/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Node/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Node/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Node/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Node/#methods","text":"delete getActiveConditions getAge getAnnotations getConditions getCpuCapacity getCreationTimestamp getFinalizers getId getKubeletVersion getLabels getMemoryCapacity getName getNodeConditionText getNs getOperatingSystem getOwnerRefs getResourceVersion getRoleLabelItems getRoleLabels getScopedName getSearchFields getTaints getTimeDiffFromNow getWarningConditions isMasterNode isUnschedulable patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Node/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Node/#constructor","text":"\u2022 new Node ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Node/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Node/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Node/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Node/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Node/#spec","text":"\u2022 spec : NodeSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Node/#status","text":"\u2022 Optional status : NodeStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Node/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/nodes\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Node/#kind_1","text":"\u25aa Static Readonly kind : \"Node\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Node/#namespaced","text":"\u25aa Static Readonly namespaced : false","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Node/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Node/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Node/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Node/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getactiveconditions","text":"\u25b8 getActiveConditions (): NodeCondition []","title":"getActiveConditions"},{"location":"extensions/api/classes/Main.K8sApi.Node/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getconditions","text":"\u25b8 getConditions (): NodeCondition []","title":"getConditions"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getcpucapacity","text":"\u25b8 getCpuCapacity (): undefined | number","title":"getCpuCapacity"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getkubeletversion","text":"\u25b8 getKubeletVersion (): string","title":"getKubeletVersion"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getmemorycapacity","text":"\u25b8 getMemoryCapacity (): number","title":"getMemoryCapacity"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getnodeconditiontext","text":"\u25b8 getNodeConditionText (): string Returns the concatination of all current condition types which have a status of \"True\"","title":"getNodeConditionText"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getoperatingsystem","text":"\u25b8 getOperatingSystem (): string","title":"getOperatingSystem"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getrolelabelitems","text":"\u25b8 getRoleLabelItems (): string []","title":"getRoleLabelItems"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getrolelabels","text":"\u25b8 getRoleLabels (): string","title":"getRoleLabels"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Node/#gettaints","text":"\u25b8 getTaints (): NodeTaint []","title":"getTaints"},{"location":"extensions/api/classes/Main.K8sApi.Node/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getwarningconditions","text":"\u25b8 getWarningConditions (): NodeCondition []","title":"getWarningConditions"},{"location":"extensions/api/classes/Main.K8sApi.Node/#ismasternode","text":"\u25b8 isMasterNode (): boolean","title":"isMasterNode"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isunschedulable","text":"\u25b8 isUnschedulable (): undefined | boolean","title":"isUnschedulable"},{"location":"extensions/api/classes/Main.K8sApi.Node/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Node/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Node/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Node/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Node/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Node/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Node/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Node/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Node/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/","text":"Class: PersistentVolume # Main . K8sApi .PersistentVolume Hierarchy # KubeObject < ClusterScopedMetadata , PersistentVolumeStatus , PersistentVolumeSpec > \u21b3 PersistentVolume Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCapacity getClaimRefName getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getStatus getStorageClass getStorageClassName getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new PersistentVolume ( data ) Parameters # Name Type data KubeJsonApiData < ClusterScopedMetadata , PersistentVolumeStatus , PersistentVolumeSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : PersistentVolumeSpec Inherited from # KubeObject . spec status # \u2022 Optional status : PersistentVolumeStatus Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCapacity # \u25b8 getCapacity ( inBytes? ): string | number Parameters # Name Type inBytes? boolean Returns # string | number getClaimRefName # \u25b8 getClaimRefName (): string Returns # string getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getStatus # \u25b8 getStatus (): string Returns # string getStorageClass # \u25b8 getStorageClass (): string Returns # string getStorageClassName # \u25b8 getStorageClassName (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < PersistentVolume > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: PersistentVolume"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#class-persistentvolume","text":"Main . K8sApi .PersistentVolume","title":"Class: PersistentVolume"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#hierarchy","text":"KubeObject < ClusterScopedMetadata , PersistentVolumeStatus , PersistentVolumeSpec > \u21b3 PersistentVolume","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#methods","text":"delete getAge getAnnotations getCapacity getClaimRefName getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getStatus getStorageClass getStorageClassName getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#constructor","text":"\u2022 new PersistentVolume ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#spec","text":"\u2022 spec : PersistentVolumeSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#status","text":"\u2022 Optional status : PersistentVolumeStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getcapacity","text":"\u25b8 getCapacity ( inBytes? ): string | number","title":"getCapacity"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getclaimrefname","text":"\u25b8 getClaimRefName (): string","title":"getClaimRefName"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getstatus","text":"\u25b8 getStatus (): string","title":"getStatus"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getstorageclass","text":"\u25b8 getStorageClass (): string","title":"getStorageClass"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getstorageclassname","text":"\u25b8 getStorageClassName (): string","title":"getStorageClassName"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/","text":"Class: PersistentVolumeClaim # Main . K8sApi .PersistentVolumeClaim Hierarchy # KubeObject < NamespaceScopedMetadata , PersistentVolumeClaimStatus , PersistentVolumeClaimSpec > \u21b3 PersistentVolumeClaim Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getMatchExpressions getMatchLabels getName getNs getOwnerRefs getPods getResourceVersion getScopedName getSearchFields getStatus getStorage getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new PersistentVolumeClaim ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , PersistentVolumeClaimStatus , PersistentVolumeClaimSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : PersistentVolumeClaimSpec Inherited from # KubeObject . spec status # \u2022 Optional status : PersistentVolumeClaimStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/api/v1/persistentvolumeclaims\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"PersistentVolumeClaim\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMatchExpressions # \u25b8 getMatchExpressions (): LabelMatchExpression [] Returns # LabelMatchExpression [] getMatchLabels # \u25b8 getMatchLabels (): string [] Returns # string [] getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPods # \u25b8 getPods ( pods ): Pod [] Parameters # Name Type pods Pod [] Returns # Pod [] getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getStatus # \u25b8 getStatus (): string Returns # string getStorage # \u25b8 getStorage (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < PersistentVolumeClaim > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: PersistentVolumeClaim"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#class-persistentvolumeclaim","text":"Main . K8sApi .PersistentVolumeClaim","title":"Class: PersistentVolumeClaim"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , PersistentVolumeClaimStatus , PersistentVolumeClaimSpec > \u21b3 PersistentVolumeClaim","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getMatchExpressions getMatchLabels getName getNs getOwnerRefs getPods getResourceVersion getScopedName getSearchFields getStatus getStorage getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#constructor","text":"\u2022 new PersistentVolumeClaim ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#spec","text":"\u2022 spec : PersistentVolumeClaimSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#status","text":"\u2022 Optional status : PersistentVolumeClaimStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/persistentvolumeclaims\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#kind_1","text":"\u25aa Static Readonly kind : \"PersistentVolumeClaim\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getmatchexpressions","text":"\u25b8 getMatchExpressions (): LabelMatchExpression []","title":"getMatchExpressions"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getmatchlabels","text":"\u25b8 getMatchLabels (): string []","title":"getMatchLabels"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getpods","text":"\u25b8 getPods ( pods ): Pod []","title":"getPods"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getstatus","text":"\u25b8 getStatus (): string","title":"getStatus"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getstorage","text":"\u25b8 getStorage (): string","title":"getStorage"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Pod/","text":"Class: Pod # Main . K8sApi .Pod Hierarchy # KubeObject < NamespaceScopedMetadata , PodStatus , PodSpec > \u21b3 Pod Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAllContainers getAnnotations getConditions getContainerStatuses getContainers getCreationTimestamp getFinalizers getIPs getId getInitContainers getLabels getLivenessProbe getName getNodeName getNodeSelectors getNs getOwnerRefs getPriorityClassName getQosClass getReadinessProbe getReason getResourceVersion getRestartsCount getRunningContainers getRuntimeClassName getScopedName getSearchFields getSecrets getSelectedNodeOs getServiceAccountName getStartupProbe getStatus getStatusMessage getStatusPhase getTimeDiffFromNow getTolerations getVolumes hasIssues patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Pod ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , PodStatus , PodSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : PodSpec Inherited from # KubeObject . spec status # \u2022 Optional status : PodStatus Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAffinity # \u25b8 getAffinity (): Affinity Returns # Affinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAllContainers # \u25b8 getAllContainers (): IPodContainer [] Returns # IPodContainer [] getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getConditions # \u25b8 getConditions (): PodCondition [] Returns # PodCondition [] getContainerStatuses # \u25b8 getContainerStatuses ( includeInitContainers? ): IPodContainerStatus [] Parameters # Name Type includeInitContainers? boolean Returns # IPodContainerStatus [] getContainers # \u25b8 getContainers (): IPodContainer [] Returns # IPodContainer [] getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getIPs # \u25b8 getIPs (): string [] Returns # string [] getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getInitContainers # \u25b8 getInitContainers (): IPodContainer [] Returns # IPodContainer [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLivenessProbe # \u25b8 getLivenessProbe ( container ): string [] Parameters # Name Type container IPodContainer Returns # string [] getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeName # \u25b8 getNodeName (): undefined | string Returns # undefined | string getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPriorityClassName # \u25b8 getPriorityClassName (): string Returns # string getQosClass # \u25b8 getQosClass (): string Returns # string getReadinessProbe # \u25b8 getReadinessProbe ( container ): string [] Parameters # Name Type container IPodContainer Returns # string [] getReason # \u25b8 getReason (): string Returns # string getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRestartsCount # \u25b8 getRestartsCount (): number Returns # number getRunningContainers # \u25b8 getRunningContainers (): IPodContainer [] Returns # IPodContainer [] getRuntimeClassName # \u25b8 getRuntimeClassName (): string Returns # string getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSecrets # \u25b8 getSecrets (): string [] Returns # string [] getSelectedNodeOs # \u25b8 getSelectedNodeOs (): undefined | string Returns # undefined | string getServiceAccountName # \u25b8 getServiceAccountName (): string Returns # string getStartupProbe # \u25b8 getStartupProbe ( container ): string [] Parameters # Name Type container IPodContainer Returns # string [] getStatus # \u25b8 getStatus (): PodStatusPhase Returns # PodStatusPhase getStatusMessage # \u25b8 getStatusMessage (): string Returns # string getStatusPhase # \u25b8 getStatusPhase (): undefined | string Returns # undefined | string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): Toleration [] Returns # Toleration [] getVolumes # \u25b8 getVolumes (): PodSpecVolume [] Returns # PodSpecVolume [] hasIssues # \u25b8 hasIssues (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Pod > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Pod"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#class-pod","text":"Main . K8sApi .Pod","title":"Class: Pod"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , PodStatus , PodSpec > \u21b3 Pod","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#methods","text":"delete getAffinity getAffinityNumber getAge getAllContainers getAnnotations getConditions getContainerStatuses getContainers getCreationTimestamp getFinalizers getIPs getId getInitContainers getLabels getLivenessProbe getName getNodeName getNodeSelectors getNs getOwnerRefs getPriorityClassName getQosClass getReadinessProbe getReason getResourceVersion getRestartsCount getRunningContainers getRuntimeClassName getScopedName getSearchFields getSecrets getSelectedNodeOs getServiceAccountName getStartupProbe getStatus getStatusMessage getStatusPhase getTimeDiffFromNow getTolerations getVolumes hasIssues patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#constructor","text":"\u2022 new Pod ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#spec","text":"\u2022 spec : PodSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#status","text":"\u2022 Optional status : PodStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getaffinity","text":"\u25b8 getAffinity (): Affinity","title":"getAffinity"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getallcontainers","text":"\u25b8 getAllContainers (): IPodContainer []","title":"getAllContainers"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getconditions","text":"\u25b8 getConditions (): PodCondition []","title":"getConditions"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getcontainerstatuses","text":"\u25b8 getContainerStatuses ( includeInitContainers? ): IPodContainerStatus []","title":"getContainerStatuses"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getcontainers","text":"\u25b8 getContainers (): IPodContainer []","title":"getContainers"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getips","text":"\u25b8 getIPs (): string []","title":"getIPs"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getinitcontainers","text":"\u25b8 getInitContainers (): IPodContainer []","title":"getInitContainers"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getlivenessprobe","text":"\u25b8 getLivenessProbe ( container ): string []","title":"getLivenessProbe"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getnodename","text":"\u25b8 getNodeName (): undefined | string","title":"getNodeName"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getpriorityclassname","text":"\u25b8 getPriorityClassName (): string","title":"getPriorityClassName"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getqosclass","text":"\u25b8 getQosClass (): string","title":"getQosClass"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getreadinessprobe","text":"\u25b8 getReadinessProbe ( container ): string []","title":"getReadinessProbe"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getreason","text":"\u25b8 getReason (): string","title":"getReason"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getrestartscount","text":"\u25b8 getRestartsCount (): number","title":"getRestartsCount"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getrunningcontainers","text":"\u25b8 getRunningContainers (): IPodContainer []","title":"getRunningContainers"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getruntimeclassname","text":"\u25b8 getRuntimeClassName (): string","title":"getRuntimeClassName"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getsecrets","text":"\u25b8 getSecrets (): string []","title":"getSecrets"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getselectednodeos","text":"\u25b8 getSelectedNodeOs (): undefined | string","title":"getSelectedNodeOs"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getserviceaccountname","text":"\u25b8 getServiceAccountName (): string","title":"getServiceAccountName"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstartupprobe","text":"\u25b8 getStartupProbe ( container ): string []","title":"getStartupProbe"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstatus","text":"\u25b8 getStatus (): PodStatusPhase","title":"getStatus"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstatusmessage","text":"\u25b8 getStatusMessage (): string","title":"getStatusMessage"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstatusphase","text":"\u25b8 getStatusPhase (): undefined | string","title":"getStatusPhase"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#gettolerations","text":"\u25b8 getTolerations (): Toleration []","title":"getTolerations"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getvolumes","text":"\u25b8 getVolumes (): PodSpecVolume []","title":"getVolumes"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#hasissues","text":"\u25b8 hasIssues (): boolean","title":"hasIssues"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/","text":"Class: PodDisruptionBudget # Main . K8sApi .PodDisruptionBudget Hierarchy # KubeObject < NamespaceScopedMetadata , PodDisruptionBudgetStatus , PodDisruptionBudgetSpec > \u21b3 PodDisruptionBudget Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getCurrentHealthy getDesiredHealthy getFinalizers getId getLabels getMaxUnavailable getMinAvailable getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSelectors getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new PodDisruptionBudget ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , PodDisruptionBudgetStatus , PodDisruptionBudgetSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : PodDisruptionBudgetSpec Inherited from # KubeObject . spec status # \u2022 Optional status : PodDisruptionBudgetStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/policy/v1beta1/poddisruptionbudgets\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"PodDisruptionBudget\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getCurrentHealthy # \u25b8 getCurrentHealthy (): number Returns # number getDesiredHealthy # \u25b8 getDesiredHealthy (): number Returns # number getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMaxUnavailable # \u25b8 getMaxUnavailable (): string | number Returns # string | number getMinAvailable # \u25b8 getMinAvailable (): string | number Returns # string | number getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < PodDisruptionBudget > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: PodDisruptionBudget"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#class-poddisruptionbudget","text":"Main . K8sApi .PodDisruptionBudget","title":"Class: PodDisruptionBudget"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , PodDisruptionBudgetStatus , PodDisruptionBudgetSpec > \u21b3 PodDisruptionBudget","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#methods","text":"delete getAge getAnnotations getCreationTimestamp getCurrentHealthy getDesiredHealthy getFinalizers getId getLabels getMaxUnavailable getMinAvailable getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSelectors getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#constructor","text":"\u2022 new PodDisruptionBudget ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#spec","text":"\u2022 spec : PodDisruptionBudgetSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#status","text":"\u2022 Optional status : PodDisruptionBudgetStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/policy/v1beta1/poddisruptionbudgets\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#kind_1","text":"\u25aa Static Readonly kind : \"PodDisruptionBudget\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getcurrenthealthy","text":"\u25b8 getCurrentHealthy (): number","title":"getCurrentHealthy"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getdesiredhealthy","text":"\u25b8 getDesiredHealthy (): number","title":"getDesiredHealthy"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getmaxunavailable","text":"\u25b8 getMaxUnavailable (): string | number","title":"getMaxUnavailable"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getminavailable","text":"\u25b8 getMinAvailable (): string | number","title":"getMinAvailable"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/","text":"Class: PriorityClass # Main . K8sApi .PriorityClass Hierarchy # KubeObject < ClusterScopedMetadata , void , void > \u21b3 PriorityClass Table of contents # Constructors # constructor Properties # apiVersion description globalDefault kind metadata preemptionPolicy spec status value apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getDescription getFinalizers getGlobalDefault getId getLabels getName getNs getOwnerRefs getPreemptionPolicy getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getValue patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new PriorityClass ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb PriorityClassData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion description # \u2022 Optional description : string globalDefault # \u2022 Optional globalDefault : boolean kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata preemptionPolicy # \u2022 Optional preemptionPolicy : PreemptionPolicy spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status value # \u2022 Optional value : number apiBase # \u25aa Static Readonly apiBase : \"/apis/scheduling.k8s.io/v1/priorityclasses\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"PriorityClass\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : false Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getDescription # \u25b8 getDescription (): string Returns # string getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getGlobalDefault # \u25b8 getGlobalDefault (): string Returns # string getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPreemptionPolicy # \u25b8 getPreemptionPolicy (): PreemptionPolicy Returns # PreemptionPolicy getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getValue # \u25b8 getValue (): undefined | number Returns # undefined | number patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < PriorityClass > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: PriorityClass"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#class-priorityclass","text":"Main . K8sApi .PriorityClass","title":"Class: PriorityClass"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#hierarchy","text":"KubeObject < ClusterScopedMetadata , void , void > \u21b3 PriorityClass","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#properties","text":"apiVersion description globalDefault kind metadata preemptionPolicy spec status value apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#methods","text":"delete getAge getAnnotations getCreationTimestamp getDescription getFinalizers getGlobalDefault getId getLabels getName getNs getOwnerRefs getPreemptionPolicy getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getValue patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#constructor","text":"\u2022 new PriorityClass ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#description","text":"\u2022 Optional description : string","title":"description"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#globaldefault","text":"\u2022 Optional globalDefault : boolean","title":"globalDefault"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#preemptionpolicy","text":"\u2022 Optional preemptionPolicy : PreemptionPolicy","title":"preemptionPolicy"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#value","text":"\u2022 Optional value : number","title":"value"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/scheduling.k8s.io/v1/priorityclasses\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#kind_1","text":"\u25aa Static Readonly kind : \"PriorityClass\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#namespaced","text":"\u25aa Static Readonly namespaced : false","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getdescription","text":"\u25b8 getDescription (): string","title":"getDescription"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getglobaldefault","text":"\u25b8 getGlobalDefault (): string","title":"getGlobalDefault"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getpreemptionpolicy","text":"\u25b8 getPreemptionPolicy (): PreemptionPolicy","title":"getPreemptionPolicy"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getvalue","text":"\u25b8 getValue (): undefined | number","title":"getValue"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/","text":"Class: ReplicaSet # Main . K8sApi .ReplicaSet Hierarchy # KubeObject < NamespaceScopedMetadata , ReplicaSetStatus , ReplicaSetSpec > \u21b3 ReplicaSet Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getCreationTimestamp getCurrent getDesired getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getReady getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ReplicaSet ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , ReplicaSetStatus , ReplicaSetSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : ReplicaSetSpec Inherited from # KubeObject . spec status # \u2022 Optional status : ReplicaSetStatus Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAffinity # \u25b8 getAffinity (): undefined | Affinity Returns # undefined | Affinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getCurrent # \u25b8 getCurrent (): number Returns # number getDesired # \u25b8 getDesired (): number Returns # number getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getImages # \u25b8 getImages (): ( undefined | string )[] Returns # ( undefined | string )[] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getReady # \u25b8 getReady (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): Toleration [] Returns # Toleration [] patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < ReplicaSet > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ReplicaSet"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#class-replicaset","text":"Main . K8sApi .ReplicaSet","title":"Class: ReplicaSet"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , ReplicaSetStatus , ReplicaSetSpec > \u21b3 ReplicaSet","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getCreationTimestamp getCurrent getDesired getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getReady getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#constructor","text":"\u2022 new ReplicaSet ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#spec","text":"\u2022 spec : ReplicaSetSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#status","text":"\u2022 Optional status : ReplicaSetStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getaffinity","text":"\u25b8 getAffinity (): undefined | Affinity","title":"getAffinity"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getcurrent","text":"\u25b8 getCurrent (): number","title":"getCurrent"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getdesired","text":"\u25b8 getDesired (): number","title":"getDesired"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getimages","text":"\u25b8 getImages (): ( undefined | string )[]","title":"getImages"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getready","text":"\u25b8 getReady (): number","title":"getReady"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#gettolerations","text":"\u25b8 getTolerations (): Toleration []","title":"getTolerations"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/","text":"Class: ResourceQuota # Main . K8sApi .ResourceQuota Hierarchy # KubeObject < NamespaceScopedMetadata , ResourceQuotaStatus , ResourceQuotaSpec > \u21b3 ResourceQuota Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopeSelector getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ResourceQuota ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , ResourceQuotaStatus , ResourceQuotaSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : ResourceQuotaSpec Inherited from # KubeObject . spec status # \u2022 Optional status : ResourceQuotaStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/api/v1/resourcequotas\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"ResourceQuota\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopeSelector # \u25b8 getScopeSelector (): { operator : string ; scopeName : string ; values : string [] }[] Returns # { operator : string ; scopeName : string ; values : string [] }[] getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < ResourceQuota > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ResourceQuota"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#class-resourcequota","text":"Main . K8sApi .ResourceQuota","title":"Class: ResourceQuota"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , ResourceQuotaStatus , ResourceQuotaSpec > \u21b3 ResourceQuota","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopeSelector getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#constructor","text":"\u2022 new ResourceQuota ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#spec","text":"\u2022 spec : ResourceQuotaSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#status","text":"\u2022 Optional status : ResourceQuotaStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/resourcequotas\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#kind_1","text":"\u25aa Static Readonly kind : \"ResourceQuota\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getscopeselector","text":"\u25b8 getScopeSelector (): { operator : string ; scopeName : string ; values : string [] }[]","title":"getScopeSelector"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/","text":"Class: ResourceStack # Main . K8sApi .ResourceStack Deprecated Switch to using Common.createResourceStack instead Implements # ResourceApplyingStack Table of contents # Constructors # constructor Methods # kubectlApplyFolder kubectlDeleteFolder Constructors # constructor # \u2022 new ResourceStack ( cluster , name ) Parameters # Name Type cluster KubernetesCluster < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > name string Methods # kubectlApplyFolder # \u25b8 kubectlApplyFolder ( folderPath , templateContext? , extraArgs? ): Promise < string > Parameters # Name Type folderPath string templateContext? any extraArgs? string [] Returns # Promise < string > Implementation of # ResourceApplyingStack.kubectlApplyFolder kubectlDeleteFolder # \u25b8 kubectlDeleteFolder ( folderPath , templateContext? , extraArgs? ): Promise < string > Parameters # Name Type folderPath string templateContext? any extraArgs? string [] Returns # Promise < string > Implementation of # ResourceApplyingStack.kubectlDeleteFolder","title":"Class: ResourceStack"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#class-resourcestack","text":"Main . K8sApi .ResourceStack Deprecated Switch to using Common.createResourceStack instead","title":"Class: ResourceStack"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#implements","text":"ResourceApplyingStack","title":"Implements"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#methods","text":"kubectlApplyFolder kubectlDeleteFolder","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#constructor","text":"\u2022 new ResourceStack ( cluster , name )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#kubectlapplyfolder","text":"\u25b8 kubectlApplyFolder ( folderPath , templateContext? , extraArgs? ): Promise < string >","title":"kubectlApplyFolder"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#kubectldeletefolder","text":"\u25b8 kubectlDeleteFolder ( folderPath , templateContext? , extraArgs? ): Promise < string >","title":"kubectlDeleteFolder"},{"location":"extensions/api/classes/Main.K8sApi.Role/","text":"Class: Role # Main . K8sApi .Role Hierarchy # KubeObject < NamespaceScopedMetadata , void , void > \u21b3 Role Table of contents # Constructors # constructor Properties # apiVersion kind metadata rules spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Role ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb RoleData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata rules # \u2022 Optional rules : PolicyRule [] spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/rbac.authorization.k8s.io/v1/roles\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Role\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRules # \u25b8 getRules (): PolicyRule [] Returns # PolicyRule [] getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Role > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Role"},{"location":"extensions/api/classes/Main.K8sApi.Role/#class-role","text":"Main . K8sApi .Role","title":"Class: Role"},{"location":"extensions/api/classes/Main.K8sApi.Role/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , void > \u21b3 Role","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Role/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Role/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Role/#properties","text":"apiVersion kind metadata rules spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Role/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Role/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Role/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Role/#constructor","text":"\u2022 new Role ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Role/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Role/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Role/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Role/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Role/#rules","text":"\u2022 Optional rules : PolicyRule []","title":"rules"},{"location":"extensions/api/classes/Main.K8sApi.Role/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Role/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Role/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/rbac.authorization.k8s.io/v1/roles\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Role/#kind_1","text":"\u25aa Static Readonly kind : \"Role\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Role/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Role/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Role/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Role/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Role/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Role/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getrules","text":"\u25b8 getRules (): PolicyRule []","title":"getRules"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Role/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Role/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Role/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Role/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Role/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Role/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Role/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Role/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Role/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Role/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Role/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Role/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Role/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/","text":"Class: RoleBinding # Main . K8sApi .RoleBinding Hierarchy # KubeObject < NamespaceScopedMetadata , void , void > \u21b3 RoleBinding Table of contents # Constructors # constructor Properties # apiVersion kind metadata roleRef spec status subjects apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSubjectNames getSubjects getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new RoleBinding ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb RoleBindingData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata roleRef # \u2022 roleRef : RoleRef spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status subjects # \u2022 Optional subjects : Subject [] apiBase # \u25aa Static Readonly apiBase : \"/apis/rbac.authorization.k8s.io/v1/rolebindings\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"RoleBinding\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSubjectNames # \u25b8 getSubjectNames (): string Returns # string getSubjects # \u25b8 getSubjects (): Subject [] Returns # Subject [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < RoleBinding > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: RoleBinding"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#class-rolebinding","text":"Main . K8sApi .RoleBinding","title":"Class: RoleBinding"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , void > \u21b3 RoleBinding","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#properties","text":"apiVersion kind metadata roleRef spec status subjects apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSubjectNames getSubjects getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#constructor","text":"\u2022 new RoleBinding ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#roleref","text":"\u2022 roleRef : RoleRef","title":"roleRef"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#subjects","text":"\u2022 Optional subjects : Subject []","title":"subjects"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/rbac.authorization.k8s.io/v1/rolebindings\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#kind_1","text":"\u25aa Static Readonly kind : \"RoleBinding\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getsubjectnames","text":"\u25b8 getSubjectNames (): string","title":"getSubjectNames"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getsubjects","text":"\u25b8 getSubjects (): Subject []","title":"getSubjects"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Secret/","text":"Class: Secret # Main . K8sApi .Secret Hierarchy # KubeObject < NamespaceScopedMetadata , void , void > \u21b3 Secret Table of contents # Constructors # constructor Properties # apiVersion data kind metadata spec status type apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getToken patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Secret ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb SecretData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion data # \u2022 data : Partial < Record < string , string >> kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status type # \u2022 type : SecretType apiBase # \u25aa Static Readonly apiBase : \"/api/v1/secrets\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Secret\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getKeys # \u25b8 getKeys (): string [] Returns # string [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getToken # \u25b8 getToken (): undefined | string Returns # undefined | string patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Secret > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Secret"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#class-secret","text":"Main . K8sApi .Secret","title":"Class: Secret"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , void > \u21b3 Secret","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#properties","text":"apiVersion data kind metadata spec status type apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getToken patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#constructor","text":"\u2022 new Secret ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#data","text":"\u2022 data : Partial < Record < string , string >>","title":"data"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type","text":"\u2022 type : SecretType","title":"type"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/secrets\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#kind_1","text":"\u25aa Static Readonly kind : \"Secret\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getkeys","text":"\u25b8 getKeys (): string []","title":"getKeys"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#gettoken","text":"\u25b8 getToken (): undefined | string","title":"getToken"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Service/","text":"Class: Service # Main . K8sApi .Service Hierarchy # KubeObject < NamespaceScopedMetadata , ServiceStatus , ServiceSpec > \u21b3 Service Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getClusterIp getClusterIps getCreationTimestamp getExternalIps getFinalizers getId getIpFamilies getIpFamilyPolicy getLabels getLoadBalancer getName getNs getOwnerRefs getPorts getResourceVersion getScopedName getSearchFields getSelector getStatus getTimeDiffFromNow getType isActive patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Service ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , ServiceStatus , ServiceSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : ServiceSpec Inherited from # KubeObject . spec status # \u2022 Optional status : ServiceStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/api/v1/services\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Service\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getClusterIp # \u25b8 getClusterIp (): string Returns # string getClusterIps # \u25b8 getClusterIps (): string [] Returns # string [] getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getExternalIps # \u25b8 getExternalIps (): ( undefined | string )[] Returns # ( undefined | string )[] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getIpFamilies # \u25b8 getIpFamilies (): string [] Returns # string [] getIpFamilyPolicy # \u25b8 getIpFamilyPolicy (): string Returns # string getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLoadBalancer # \u25b8 getLoadBalancer (): undefined | { ingress? : { hostname? : string ; ip? : string }[] } Returns # undefined | { ingress? : { hostname? : string ; ip? : string }[] } getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPorts # \u25b8 getPorts (): ServicePort [] Returns # ServicePort [] getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelector # \u25b8 getSelector (): string [] Returns # string [] getStatus # \u25b8 getStatus (): \"Active\" | \"Pending\" Returns # \"Active\" | \"Pending\" getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getType # \u25b8 getType (): string Returns # string isActive # \u25b8 isActive (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Service > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Service"},{"location":"extensions/api/classes/Main.K8sApi.Service/#class-service","text":"Main . K8sApi .Service","title":"Class: Service"},{"location":"extensions/api/classes/Main.K8sApi.Service/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , ServiceStatus , ServiceSpec > \u21b3 Service","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Service/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Service/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Service/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Service/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Service/#methods","text":"delete getAge getAnnotations getClusterIp getClusterIps getCreationTimestamp getExternalIps getFinalizers getId getIpFamilies getIpFamilyPolicy getLabels getLoadBalancer getName getNs getOwnerRefs getPorts getResourceVersion getScopedName getSearchFields getSelector getStatus getTimeDiffFromNow getType isActive patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Service/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Service/#constructor","text":"\u2022 new Service ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Service/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Service/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Service/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Service/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Service/#spec","text":"\u2022 spec : ServiceSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Service/#status","text":"\u2022 Optional status : ServiceStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Service/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/services\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Service/#kind_1","text":"\u25aa Static Readonly kind : \"Service\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Service/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Service/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Service/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Service/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Service/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Service/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getclusterip","text":"\u25b8 getClusterIp (): string","title":"getClusterIp"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getclusterips","text":"\u25b8 getClusterIps (): string []","title":"getClusterIps"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getexternalips","text":"\u25b8 getExternalIps (): ( undefined | string )[]","title":"getExternalIps"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getipfamilies","text":"\u25b8 getIpFamilies (): string []","title":"getIpFamilies"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getipfamilypolicy","text":"\u25b8 getIpFamilyPolicy (): string","title":"getIpFamilyPolicy"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getloadbalancer","text":"\u25b8 getLoadBalancer (): undefined | { ingress? : { hostname? : string ; ip? : string }[] }","title":"getLoadBalancer"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getports","text":"\u25b8 getPorts (): ServicePort []","title":"getPorts"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getselector","text":"\u25b8 getSelector (): string []","title":"getSelector"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getstatus","text":"\u25b8 getStatus (): \"Active\" | \"Pending\"","title":"getStatus"},{"location":"extensions/api/classes/Main.K8sApi.Service/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Service/#gettype","text":"\u25b8 getType (): string","title":"getType"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isactive","text":"\u25b8 isActive (): boolean","title":"isActive"},{"location":"extensions/api/classes/Main.K8sApi.Service/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Service/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Service/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Service/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Service/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Service/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Service/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Service/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Service/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/","text":"Class: ServiceAccount # Main . K8sApi .ServiceAccount Hierarchy # KubeObject < NamespaceScopedMetadata , void , void > \u21b3 ServiceAccount Table of contents # Constructors # constructor Properties # apiVersion automountServiceAccountToken imagePullSecrets kind metadata secrets spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getImagePullSecrets getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSecrets getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ServiceAccount ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb ServiceAccountData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion automountServiceAccountToken # \u2022 Optional automountServiceAccountToken : boolean imagePullSecrets # \u2022 Optional imagePullSecrets : LocalObjectReference [] kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata secrets # \u2022 Optional secrets : ObjectReference [] spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/api/v1/serviceaccounts\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"ServiceAccount\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getImagePullSecrets # \u25b8 getImagePullSecrets (): LocalObjectReference [] Returns # LocalObjectReference [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSecrets # \u25b8 getSecrets (): ObjectReference [] Returns # ObjectReference [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < ServiceAccount > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ServiceAccount"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#class-serviceaccount","text":"Main . K8sApi .ServiceAccount","title":"Class: ServiceAccount"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , void > \u21b3 ServiceAccount","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#properties","text":"apiVersion automountServiceAccountToken imagePullSecrets kind metadata secrets spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getImagePullSecrets getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSecrets getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#constructor","text":"\u2022 new ServiceAccount ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#automountserviceaccounttoken","text":"\u2022 Optional automountServiceAccountToken : boolean","title":"automountServiceAccountToken"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#imagepullsecrets","text":"\u2022 Optional imagePullSecrets : LocalObjectReference []","title":"imagePullSecrets"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#secrets","text":"\u2022 Optional secrets : ObjectReference []","title":"secrets"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/serviceaccounts\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#kind_1","text":"\u25aa Static Readonly kind : \"ServiceAccount\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getimagepullsecrets","text":"\u25b8 getImagePullSecrets (): LocalObjectReference []","title":"getImagePullSecrets"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getsecrets","text":"\u25b8 getSecrets (): ObjectReference []","title":"getSecrets"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/","text":"Class: StatefulSet # Main . K8sApi .StatefulSet Hierarchy # KubeObject < NamespaceScopedMetadata , StatefulSetStatus , StatefulSetSpec > \u21b3 StatefulSet Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getCreationTimestamp getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new StatefulSet ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , StatefulSetStatus , StatefulSetSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : StatefulSetSpec Inherited from # KubeObject . spec status # \u2022 Optional status : StatefulSetStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/apps/v1/statefulsets\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"StatefulSet\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAffinity # \u25b8 getAffinity (): Affinity Returns # Affinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getImages # \u25b8 getImages (): ( undefined | string )[] Returns # ( undefined | string )[] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getReplicas # \u25b8 getReplicas (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): Toleration [] Returns # Toleration [] patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < StatefulSet > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: StatefulSet"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#class-statefulset","text":"Main . K8sApi .StatefulSet","title":"Class: StatefulSet"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , StatefulSetStatus , StatefulSetSpec > \u21b3 StatefulSet","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getCreationTimestamp getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#constructor","text":"\u2022 new StatefulSet ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#spec","text":"\u2022 spec : StatefulSetSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#status","text":"\u2022 Optional status : StatefulSetStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/apps/v1/statefulsets\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#kind_1","text":"\u25aa Static Readonly kind : \"StatefulSet\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getaffinity","text":"\u25b8 getAffinity (): Affinity","title":"getAffinity"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getimages","text":"\u25b8 getImages (): ( undefined | string )[]","title":"getImages"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getreplicas","text":"\u25b8 getReplicas (): number","title":"getReplicas"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#gettolerations","text":"\u25b8 getTolerations (): Toleration []","title":"getTolerations"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/","text":"Class: StorageClass # Main . K8sApi .StorageClass Hierarchy # KubeObject < ClusterScopedMetadata , void , void > \u21b3 StorageClass Table of contents # Constructors # constructor Properties # allowVolumeExpansion allowedTopologies apiVersion kind metadata mountOptions parameters provisioner reclaimPolicy spec status volumeBindingMode apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getReclaimPolicy getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getVolumeBindingMode isDefault patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new StorageClass ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb StorageClassData Overrides # KubeObject . constructor Properties # allowVolumeExpansion # \u2022 Optional allowVolumeExpansion : boolean allowedTopologies # \u2022 allowedTopologies : TopologySelectorTerm [] apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata mountOptions # \u2022 mountOptions : string [] parameters # \u2022 parameters : Partial < Record < string , string >> provisioner # \u2022 provisioner : string reclaimPolicy # \u2022 reclaimPolicy : string spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status volumeBindingMode # \u2022 Optional volumeBindingMode : string apiBase # \u25aa Static Readonly apiBase : \"/apis/storage.k8s.io/v1/storageclasses\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"StorageClass\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : false Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getReclaimPolicy # \u25b8 getReclaimPolicy (): string Returns # string getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getVolumeBindingMode # \u25b8 getVolumeBindingMode (): string Returns # string isDefault # \u25b8 isDefault (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < StorageClass > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: StorageClass"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#class-storageclass","text":"Main . K8sApi .StorageClass","title":"Class: StorageClass"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#hierarchy","text":"KubeObject < ClusterScopedMetadata , void , void > \u21b3 StorageClass","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#properties","text":"allowVolumeExpansion allowedTopologies apiVersion kind metadata mountOptions parameters provisioner reclaimPolicy spec status volumeBindingMode apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getReclaimPolicy getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getVolumeBindingMode isDefault patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#constructor","text":"\u2022 new StorageClass ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#allowvolumeexpansion","text":"\u2022 Optional allowVolumeExpansion : boolean","title":"allowVolumeExpansion"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#allowedtopologies","text":"\u2022 allowedTopologies : TopologySelectorTerm []","title":"allowedTopologies"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#mountoptions","text":"\u2022 mountOptions : string []","title":"mountOptions"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_1","text":"\u2022 parameters : Partial < Record < string , string >>","title":"parameters"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#provisioner","text":"\u2022 provisioner : string","title":"provisioner"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#reclaimpolicy","text":"\u2022 reclaimPolicy : string","title":"reclaimPolicy"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#volumebindingmode","text":"\u2022 Optional volumeBindingMode : string","title":"volumeBindingMode"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/storage.k8s.io/v1/storageclasses\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#kind_1","text":"\u25aa Static Readonly kind : \"StorageClass\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#namespaced","text":"\u25aa Static Readonly namespaced : false","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getreclaimpolicy","text":"\u25b8 getReclaimPolicy (): string","title":"getReclaimPolicy"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getvolumebindingmode","text":"\u25b8 getVolumeBindingMode (): string","title":"getVolumeBindingMode"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isdefault","text":"\u25b8 isDefault (): boolean","title":"isDefault"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.LensExtension/","text":"Class: LensExtension # Main .LensExtension Hierarchy # LensExtension < LensMainExtensionDependencies > \u21b3 LensExtension Table of contents # Constructors # constructor Properties # appMenus id isBundled manifest manifestPath protocolHandlers terminalShellEnvModifier trayMenus Accessors # description isEnabled name sanitizedExtensionId storeName version Methods # activate addCatalogSource disable enable getExtensionFileFolder navigate onActivate onDeactivate removeCatalogSource Constructors # constructor # \u2022 new LensExtension ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb InstalledExtension Inherited from # LensExtension . constructor Properties # appMenus # \u2022 appMenus : MenuRegistration [] | IComputedValue < MenuRegistration []> id # \u2022 Readonly id : string Inherited from # LensExtension . id isBundled # \u2022 Readonly isBundled : boolean Inherited from # LensExtension . isBundled manifest # \u2022 Readonly manifest : LensExtensionManifest Inherited from # LensExtension . manifest manifestPath # \u2022 Readonly manifestPath : string Inherited from # LensExtension . manifestPath protocolHandlers # \u2022 protocolHandlers : ProtocolHandlerRegistration [] Inherited from # LensExtension . protocolHandlers terminalShellEnvModifier # \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. trayMenus # \u2022 trayMenus : TrayMenuRegistration [] | IComputedValue < TrayMenuRegistration []> Accessors # description # \u2022 get description (): undefined | string Returns # undefined | string Inherited from # LensExtension.description isEnabled # \u2022 get isEnabled (): boolean Returns # boolean Inherited from # LensExtension.isEnabled name # \u2022 get name (): string Returns # string Inherited from # LensExtension.name sanitizedExtensionId # \u2022 get sanitizedExtensionId (): string Returns # string Inherited from # LensExtension.sanitizedExtensionId storeName # \u2022 get storeName (): string Returns # string Inherited from # LensExtension.storeName version # \u2022 get version (): string Returns # string Inherited from # LensExtension.version Methods # activate # \u25b8 activate (): Promise < void > Returns # Promise < void > Inherited from # LensExtension . activate addCatalogSource # \u25b8 addCatalogSource ( id , source ): void Parameters # Name Type id string source IObservableArray < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >> | IComputedValue < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >[]> Returns # void disable # \u25b8 disable (): Promise < void > Returns # Promise < void > Inherited from # LensExtension . disable enable # \u25b8 enable (): Promise < void > Returns # Promise < void > Inherited from # LensExtension . enable getExtensionFileFolder # \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. Returns # Promise < string > Inherited from # LensExtension . getExtensionFileFolder navigate # \u25b8 navigate ( pageId? , params? , frameId? ): Promise < void > Parameters # Name Type pageId? string params? Record < string , any > frameId? number Returns # Promise < void > onActivate # \u25b8 Protected onActivate (): void | Promise < void > Returns # void | Promise < void > Inherited from # LensExtension . onActivate onDeactivate # \u25b8 Protected onDeactivate (): void | Promise < void > Returns # void | Promise < void > Inherited from # LensExtension . onDeactivate removeCatalogSource # \u25b8 removeCatalogSource ( id ): void Parameters # Name Type id string Returns # void","title":"Class: LensExtension"},{"location":"extensions/api/classes/Main.LensExtension/#class-lensextension","text":"Main .LensExtension","title":"Class: LensExtension"},{"location":"extensions/api/classes/Main.LensExtension/#hierarchy","text":"LensExtension < LensMainExtensionDependencies > \u21b3 LensExtension","title":"Hierarchy"},{"location":"extensions/api/classes/Main.LensExtension/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.LensExtension/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.LensExtension/#properties","text":"appMenus id isBundled manifest manifestPath protocolHandlers terminalShellEnvModifier trayMenus","title":"Properties"},{"location":"extensions/api/classes/Main.LensExtension/#accessors","text":"description isEnabled name sanitizedExtensionId storeName version","title":"Accessors"},{"location":"extensions/api/classes/Main.LensExtension/#methods","text":"activate addCatalogSource disable enable getExtensionFileFolder navigate onActivate onDeactivate removeCatalogSource","title":"Methods"},{"location":"extensions/api/classes/Main.LensExtension/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.LensExtension/#constructor","text":"\u2022 new LensExtension ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.LensExtension/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.LensExtension/#appmenus","text":"\u2022 appMenus : MenuRegistration [] | IComputedValue < MenuRegistration []>","title":"appMenus"},{"location":"extensions/api/classes/Main.LensExtension/#id","text":"\u2022 Readonly id : string","title":"id"},{"location":"extensions/api/classes/Main.LensExtension/#isbundled","text":"\u2022 Readonly isBundled : boolean","title":"isBundled"},{"location":"extensions/api/classes/Main.LensExtension/#manifest","text":"\u2022 Readonly manifest : LensExtensionManifest","title":"manifest"},{"location":"extensions/api/classes/Main.LensExtension/#manifestpath","text":"\u2022 Readonly manifestPath : string","title":"manifestPath"},{"location":"extensions/api/classes/Main.LensExtension/#protocolhandlers","text":"\u2022 protocolHandlers : ProtocolHandlerRegistration []","title":"protocolHandlers"},{"location":"extensions/api/classes/Main.LensExtension/#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.","title":"terminalShellEnvModifier"},{"location":"extensions/api/classes/Main.LensExtension/#traymenus","text":"\u2022 trayMenus : TrayMenuRegistration [] | IComputedValue < TrayMenuRegistration []>","title":"trayMenus"},{"location":"extensions/api/classes/Main.LensExtension/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.LensExtension/#description","text":"\u2022 get description (): undefined | string","title":"description"},{"location":"extensions/api/classes/Main.LensExtension/#isenabled","text":"\u2022 get isEnabled (): boolean","title":"isEnabled"},{"location":"extensions/api/classes/Main.LensExtension/#name","text":"\u2022 get name (): string","title":"name"},{"location":"extensions/api/classes/Main.LensExtension/#sanitizedextensionid","text":"\u2022 get sanitizedExtensionId (): string","title":"sanitizedExtensionId"},{"location":"extensions/api/classes/Main.LensExtension/#storename","text":"\u2022 get storeName (): string","title":"storeName"},{"location":"extensions/api/classes/Main.LensExtension/#version","text":"\u2022 get version (): string","title":"version"},{"location":"extensions/api/classes/Main.LensExtension/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.LensExtension/#activate","text":"\u25b8 activate (): Promise < void >","title":"activate"},{"location":"extensions/api/classes/Main.LensExtension/#addcatalogsource","text":"\u25b8 addCatalogSource ( id , source ): void","title":"addCatalogSource"},{"location":"extensions/api/classes/Main.LensExtension/#disable","text":"\u25b8 disable (): Promise < void >","title":"disable"},{"location":"extensions/api/classes/Main.LensExtension/#enable","text":"\u25b8 enable (): Promise < void >","title":"enable"},{"location":"extensions/api/classes/Main.LensExtension/#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.","title":"getExtensionFileFolder"},{"location":"extensions/api/classes/Main.LensExtension/#navigate","text":"\u25b8 navigate ( pageId? , params? , frameId? ): Promise < void >","title":"navigate"},{"location":"extensions/api/classes/Main.LensExtension/#onactivate","text":"\u25b8 Protected onActivate (): void | Promise < void >","title":"onActivate"},{"location":"extensions/api/classes/Main.LensExtension/#ondeactivate","text":"\u25b8 Protected onDeactivate (): void | Promise < void >","title":"onDeactivate"},{"location":"extensions/api/classes/Main.LensExtension/#removecatalogsource","text":"\u25b8 removeCatalogSource ( id ): void","title":"removeCatalogSource"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/","text":"Class: CatalogEntityRegistry # Renderer . Catalog .CatalogEntityRegistry Table of contents # Constructors # constructor Accessors # activeEntity entities Methods # addOnBeforeRun getById getItemsForApiKind getItemsForCategory Constructors # constructor # \u2022 new CatalogEntityRegistry () Accessors # activeEntity # \u2022 get activeEntity (): undefined | CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Currently active/visible entity Returns # undefined | CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > entities # \u2022 get entities (): Map < string , CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >> Returns # Map < string , CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >> Methods # addOnBeforeRun # \u25b8 addOnBeforeRun ( onBeforeRun ): Disposer Add a onBeforeRun hook to a catalog entities. If onBeforeRun was previously added then it will not be added again. Parameters # Name Type Description 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 Returns # Disposer A function to remove that hook getById # \u25b8 getById ( id ): undefined | CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Parameters # Name Type id string Returns # undefined | CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > getItemsForApiKind # \u25b8 getItemsForApiKind < T >( apiVersion , kind ): T [] Type parameters # Name Type T extends CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec , T > Parameters # Name Type apiVersion string kind string Returns # T [] getItemsForCategory # \u25b8 getItemsForCategory < T >( category ): T [] Type parameters # Name Type T extends CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec , T > Parameters # Name Type category CatalogCategory Returns # T []","title":"Class: CatalogEntityRegistry"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#class-catalogentityregistry","text":"Renderer . Catalog .CatalogEntityRegistry","title":"Class: CatalogEntityRegistry"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#accessors","text":"activeEntity entities","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#methods","text":"addOnBeforeRun getById getItemsForApiKind getItemsForCategory","title":"Methods"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructor","text":"\u2022 new CatalogEntityRegistry ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#activeentity","text":"\u2022 get activeEntity (): undefined | CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Currently active/visible entity","title":"activeEntity"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#entities","text":"\u2022 get entities (): Map < string , CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >>","title":"entities"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#addonbeforerun","text":"\u25b8 addOnBeforeRun ( onBeforeRun ): Disposer Add a onBeforeRun hook to a catalog entities. If onBeforeRun was previously added then it will not be added again.","title":"addOnBeforeRun"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getbyid","text":"\u25b8 getById ( id ): undefined | CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >","title":"getById"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getitemsforapikind","text":"\u25b8 getItemsForApiKind < T >( apiVersion , kind ): T []","title":"getItemsForApiKind"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getitemsforcategory","text":"\u25b8 getItemsForCategory < T >( category ): T []","title":"getItemsForCategory"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/","text":"Class: DrawerParamToggler # Renderer . Component .DrawerParamToggler Hierarchy # Component < DrawerParamTogglerProps , State > \u21b3 DrawerParamToggler Table of contents # Constructors # constructor Properties # state toggle Methods # render Constructors # constructor # \u2022 new DrawerParamToggler ( props ) Parameters # Name Type props DrawerParamTogglerProps | Readonly < DrawerParamTogglerProps > Inherited from # React.Component.constructor \u2022 new DrawerParamToggler ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props DrawerParamTogglerProps context any Inherited from # React.Component.constructor Properties # state # \u2022 state : State Overrides # React.Component.state toggle # \u2022 toggle : () => void Type declaration # \u25b8 (): void Returns # void Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: DrawerParamToggler"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#class-drawerparamtoggler","text":"Renderer . Component .DrawerParamToggler","title":"Class: DrawerParamToggler"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#hierarchy","text":"Component < DrawerParamTogglerProps , State > \u21b3 DrawerParamToggler","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#properties","text":"state toggle","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#constructor","text":"\u2022 new DrawerParamToggler ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#state","text":"\u2022 state : State","title":"state"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#toggle","text":"\u2022 toggle : () => void","title":"toggle"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Input/","text":"Class: Input # Renderer . Component .Input Hierarchy # Component < InputProps , State > \u21b3 Input Table of contents # Constructors # constructor Properties # input setDirtyOnChange state validators defaultProps Accessors # isUncontrolled showMaxLenIndicator themeSelection Methods # bindRef blur componentDidMount componentDidUpdate componentWillUnmount focus getValue onBlur onChange onFocus onKeyDown render select setDirty setValidation setValue validate Constructors # constructor # \u2022 new Input ( props ) Parameters # Name Type props InputProps Overrides # React.Component.constructor Properties # input # \u2022 input : null | InputElement setDirtyOnChange # \u2022 setDirtyOnChange : DebouncedFunc <() => void > state # \u2022 state : State Overrides # React.Component.state validators # \u2022 validators : InputValidator < boolean >[] defaultProps # \u25aa Static defaultProps : object Accessors # isUncontrolled # \u2022 get isUncontrolled (): boolean Returns # boolean showMaxLenIndicator # \u2022 get showMaxLenIndicator (): undefined | boolean | 0 Returns # undefined | boolean | 0 themeSelection # \u2022 get themeSelection (): Record < string , boolean > Returns # Record < string , boolean > Methods # bindRef # \u25b8 bindRef ( elem ): void Parameters # Name Type elem InputElement Returns # void blur # \u25b8 blur (): void Returns # void componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 componentDidUpdate ( prevProps ): void Parameters # Name Type prevProps InputProps Returns # void Overrides # React.Component.componentDidUpdate componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount focus # \u25b8 focus (): void Returns # void getValue # \u25b8 getValue (): string Returns # string onBlur # \u25b8 onBlur ( evt ): void Parameters # Name Type evt FocusEvent < InputElement , Element > Returns # void onChange # \u25b8 onChange ( evt ): Promise < void > Parameters # Name Type evt ChangeEvent < any > Returns # Promise < void > onFocus # \u25b8 onFocus ( evt ): void Parameters # Name Type evt FocusEvent < InputElement , Element > Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent < InputElement > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render select # \u25b8 select (): void Returns # void setDirty # \u25b8 setDirty ( dirty? ): void Parameters # Name Type dirty? boolean Returns # void setValidation # \u25b8 setValidation ( errors ): void Parameters # Name Type errors ReactNode [] Returns # void setValue # \u25b8 setValue ( value? ): void Parameters # Name Type value? string Returns # void validate # \u25b8 validate (): Promise < void > Returns # Promise < void >","title":"Class: Input"},{"location":"extensions/api/classes/Renderer.Component.Input/#class-input","text":"Renderer . Component .Input","title":"Class: Input"},{"location":"extensions/api/classes/Renderer.Component.Input/#hierarchy","text":"Component < InputProps , State > \u21b3 Input","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Input/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Input/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Input/#properties","text":"input setDirtyOnChange state validators defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Input/#accessors","text":"isUncontrolled showMaxLenIndicator themeSelection","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Input/#methods","text":"bindRef blur componentDidMount componentDidUpdate componentWillUnmount focus getValue onBlur onChange onFocus onKeyDown render select setDirty setValidation setValue validate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Input/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Input/#constructor","text":"\u2022 new Input ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Input/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Input/#input","text":"\u2022 input : null | InputElement","title":"input"},{"location":"extensions/api/classes/Renderer.Component.Input/#setdirtyonchange","text":"\u2022 setDirtyOnChange : DebouncedFunc <() => void >","title":"setDirtyOnChange"},{"location":"extensions/api/classes/Renderer.Component.Input/#state","text":"\u2022 state : State","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Input/#validators","text":"\u2022 validators : InputValidator < boolean >[]","title":"validators"},{"location":"extensions/api/classes/Renderer.Component.Input/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Input/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Input/#isuncontrolled","text":"\u2022 get isUncontrolled (): boolean","title":"isUncontrolled"},{"location":"extensions/api/classes/Renderer.Component.Input/#showmaxlenindicator","text":"\u2022 get showMaxLenIndicator (): undefined | boolean | 0","title":"showMaxLenIndicator"},{"location":"extensions/api/classes/Renderer.Component.Input/#themeselection","text":"\u2022 get themeSelection (): Record < string , boolean >","title":"themeSelection"},{"location":"extensions/api/classes/Renderer.Component.Input/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Input/#bindref","text":"\u25b8 bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/Renderer.Component.Input/#blur","text":"\u25b8 blur (): void","title":"blur"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentdidupdate","text":"\u25b8 componentDidUpdate ( prevProps ): void","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Input/#focus","text":"\u25b8 focus (): void","title":"focus"},{"location":"extensions/api/classes/Renderer.Component.Input/#getvalue","text":"\u25b8 getValue (): string","title":"getValue"},{"location":"extensions/api/classes/Renderer.Component.Input/#onblur","text":"\u25b8 onBlur ( evt ): void","title":"onBlur"},{"location":"extensions/api/classes/Renderer.Component.Input/#onchange","text":"\u25b8 onChange ( evt ): Promise < void >","title":"onChange"},{"location":"extensions/api/classes/Renderer.Component.Input/#onfocus","text":"\u25b8 onFocus ( evt ): void","title":"onFocus"},{"location":"extensions/api/classes/Renderer.Component.Input/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/Renderer.Component.Input/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Input/#select","text":"\u25b8 select (): void","title":"select"},{"location":"extensions/api/classes/Renderer.Component.Input/#setdirty","text":"\u25b8 setDirty ( dirty? ): void","title":"setDirty"},{"location":"extensions/api/classes/Renderer.Component.Input/#setvalidation","text":"\u25b8 setValidation ( errors ): void","title":"setValidation"},{"location":"extensions/api/classes/Renderer.Component.Input/#setvalue","text":"\u25b8 setValue ( value? ): void","title":"setValue"},{"location":"extensions/api/classes/Renderer.Component.Input/#validate","text":"\u25b8 validate (): Promise < void >","title":"validate"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/","text":"Class: MenuItem # Renderer . Component .MenuItem Hierarchy # Component < MenuItemProps > \u21b3 MenuItem Table of contents # Constructors # constructor Properties # context elem contextType defaultProps Accessors # isFocusable isLink Methods # bindRef onClick render Constructors # constructor # \u2022 new MenuItem ( props ) Parameters # Name Type props MenuItemProps Overrides # React.Component.constructor Properties # context # \u2022 context : MenuContextValue Overrides # React.Component.context elem # \u2022 elem : null | HTMLElement contextType # \u25aa Static contextType : Context < null | MenuContextValue > Overrides # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Accessors # isFocusable # \u2022 get isFocusable (): boolean Returns # boolean isLink # \u2022 get isLink (): boolean Returns # boolean Methods # bindRef # \u25b8 Protected bindRef ( elem ): void Parameters # Name Type elem HTMLElement Returns # void onClick # \u25b8 onClick ( evt ): void Parameters # Name Type evt MouseEvent < Element , MouseEvent > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: MenuItem"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#class-menuitem","text":"Renderer . Component .MenuItem","title":"Class: MenuItem"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#hierarchy","text":"Component < MenuItemProps > \u21b3 MenuItem","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#properties","text":"context elem contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#accessors","text":"isFocusable isLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#methods","text":"bindRef onClick render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#constructor","text":"\u2022 new MenuItem ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#context","text":"\u2022 context : MenuContextValue","title":"context"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#elem","text":"\u2022 elem : null | HTMLElement","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#contexttype","text":"\u25aa Static contextType : Context < null | MenuContextValue >","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#isfocusable","text":"\u2022 get isFocusable (): boolean","title":"isFocusable"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#islink","text":"\u2022 get isLink (): boolean","title":"isLink"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#bindref","text":"\u25b8 Protected bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#onclick","text":"\u25b8 onClick ( evt ): void","title":"onClick"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/","text":"Class: NotificationsStore # Renderer . Component .NotificationsStore Table of contents # Constructors # constructor Properties # autoHideTimers notifications Methods # add addAutoHideTimer getById remove removeAutoHideTimer Constructors # constructor # \u2022 new NotificationsStore () Properties # autoHideTimers # \u2022 Protected autoHideTimers : Map < NotificationId , number > notifications # \u2022 notifications : IObservableArray < Simplify < Except < Notification , \"id\" > & Required < Pick < Notification , \"id\" >>>> Methods # add # \u25b8 add ( rawNotification ): () => void Parameters # Name Type rawNotification Notification Returns # fn \u25b8 (): void Returns # void addAutoHideTimer # \u25b8 addAutoHideTimer ( id ): void Parameters # Name Type id NotificationId Returns # void getById # \u25b8 getById ( id ): undefined | Simplify < Except < Notification , \"id\" > & Required < Pick < Notification , \"id\" >>> Parameters # Name Type id NotificationId Returns # undefined | Simplify < Except < Notification , \"id\" > & Required < Pick < Notification , \"id\" >>> remove # \u25b8 remove ( id ): void Parameters # Name Type id NotificationId Returns # void removeAutoHideTimer # \u25b8 removeAutoHideTimer ( id ): void Parameters # Name Type id NotificationId Returns # void","title":"Class: NotificationsStore"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#class-notificationsstore","text":"Renderer . Component .NotificationsStore","title":"Class: NotificationsStore"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#properties","text":"autoHideTimers notifications","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#methods","text":"add addAutoHideTimer getById remove removeAutoHideTimer","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructor","text":"\u2022 new NotificationsStore ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#autohidetimers","text":"\u2022 Protected autoHideTimers : Map < NotificationId , number >","title":"autoHideTimers"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#notifications","text":"\u2022 notifications : IObservableArray < Simplify < Except < Notification , \"id\" > & Required < Pick < Notification , \"id\" >>>>","title":"notifications"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#add","text":"\u25b8 add ( rawNotification ): () => void","title":"add"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#addautohidetimer","text":"\u25b8 addAutoHideTimer ( id ): void","title":"addAutoHideTimer"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Simplify < Except < Notification , \"id\" > & Required < Pick < Notification , \"id\" >>>","title":"getById"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#remove","text":"\u25b8 remove ( id ): void","title":"remove"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#removeautohidetimer","text":"\u25b8 removeAutoHideTimer ( id ): void","title":"removeAutoHideTimer"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/","text":"Class: PageLayout # Renderer . Component .PageLayout PageLayout is deprecated. See MainLayout & SettingLayout Deprecated Hierarchy # SettingLayout \u21b3 PageLayout Table of contents # Constructors # constructor Properties # onEscapeKey defaultProps Methods # componentDidMount componentWillUnmount render Constructors # constructor # \u2022 new PageLayout ( props ) Parameters # Name Type props SettingLayoutProps | Readonly < SettingLayoutProps > Inherited from # SettingLayout . constructor \u2022 new PageLayout ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SettingLayoutProps context any Inherited from # SettingLayout . constructor Properties # onEscapeKey # \u2022 onEscapeKey : ( evt : KeyboardEvent ) => void Type declaration # \u25b8 ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void Inherited from # SettingLayout . onEscapeKey defaultProps # \u25aa Static defaultProps : object Inherited from # SettingLayout . defaultProps Methods # componentDidMount # \u25b8 componentDidMount (): Promise < void > Returns # Promise < void > Inherited from # SettingLayout . componentDidMount componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Inherited from # SettingLayout . componentWillUnmount render # \u25b8 render (): Element Returns # Element Inherited from # SettingLayout . render","title":"Class: PageLayout"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#class-pagelayout","text":"Renderer . Component .PageLayout PageLayout is deprecated. See MainLayout & SettingLayout Deprecated","title":"Class: PageLayout"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#hierarchy","text":"SettingLayout \u21b3 PageLayout","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#properties","text":"onEscapeKey defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#methods","text":"componentDidMount componentWillUnmount render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#constructor","text":"\u2022 new PageLayout ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#onescapekey","text":"\u2022 onEscapeKey : ( evt : KeyboardEvent ) => void","title":"onEscapeKey"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentdidmount","text":"\u25b8 componentDidMount (): Promise < void >","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/","text":"Class: SettingLayout # Renderer . Component .SettingLayout Layout for settings like pages with navigation Hierarchy # Component < SettingLayoutProps > \u21b3 SettingLayout \u21b3\u21b3 PageLayout Table of contents # Constructors # constructor Properties # onEscapeKey defaultProps Methods # componentDidMount componentWillUnmount render Constructors # constructor # \u2022 new SettingLayout ( props ) Parameters # Name Type props SettingLayoutProps | Readonly < SettingLayoutProps > Inherited from # React.Component.constructor \u2022 new SettingLayout ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SettingLayoutProps context any Inherited from # React.Component.constructor Properties # onEscapeKey # \u2022 onEscapeKey : ( evt : KeyboardEvent ) => void Type declaration # \u25b8 ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void defaultProps # \u25aa Static defaultProps : object Methods # componentDidMount # \u25b8 componentDidMount (): Promise < void > Returns # Promise < void > Overrides # React.Component.componentDidMount componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: SettingLayout"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#class-settinglayout","text":"Renderer . Component .SettingLayout Layout for settings like pages with navigation","title":"Class: SettingLayout"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#hierarchy","text":"Component < SettingLayoutProps > \u21b3 SettingLayout \u21b3\u21b3 PageLayout","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#properties","text":"onEscapeKey defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#methods","text":"componentDidMount componentWillUnmount render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#constructor","text":"\u2022 new SettingLayout ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#onescapekey","text":"\u2022 onEscapeKey : ( evt : KeyboardEvent ) => void","title":"onEscapeKey"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentdidmount","text":"\u25b8 componentDidMount (): Promise < void >","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Slider/","text":"Class: Slider # Renderer . Component .Slider Hierarchy # Component < SliderProps > \u21b3 Slider Table of contents # Constructors # constructor Properties # defaultProps Methods # render Constructors # constructor # \u2022 new Slider ( props ) Parameters # Name Type props SliderProps | Readonly < SliderProps > Inherited from # Component.constructor \u2022 new Slider ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SliderProps context any Inherited from # Component.constructor Properties # defaultProps # \u25aa Static defaultProps : object Methods # render # \u25b8 render (): Element Returns # Element Overrides # Component.render","title":"Class: Slider"},{"location":"extensions/api/classes/Renderer.Component.Slider/#class-slider","text":"Renderer . Component .Slider","title":"Class: Slider"},{"location":"extensions/api/classes/Renderer.Component.Slider/#hierarchy","text":"Component < SliderProps > \u21b3 Slider","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Slider/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Slider/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Slider/#properties","text":"defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Slider/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Slider/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Slider/#constructor","text":"\u2022 new Slider ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Slider/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Slider/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Slider/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Slider/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Spinner/","text":"Class: Spinner # Renderer . Component .Spinner Hierarchy # Component < SpinnerProps , {}> \u21b3 Spinner Table of contents # Constructors # constructor Properties # defaultProps Methods # render Constructors # constructor # \u2022 new Spinner ( props ) Parameters # Name Type props SpinnerProps | Readonly < SpinnerProps > Inherited from # React.Component.constructor \u2022 new Spinner ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SpinnerProps context any Inherited from # React.Component.constructor Properties # defaultProps # \u25aa Static defaultProps : Object Type declaration # Name Type center boolean singleColor boolean Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: Spinner"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#class-spinner","text":"Renderer . Component .Spinner","title":"Class: Spinner"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#hierarchy","text":"Component < SpinnerProps , {}> \u21b3 Spinner","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#properties","text":"defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#constructor","text":"\u2022 new Spinner ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#defaultprops","text":"\u25aa Static defaultProps : Object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Stepper/","text":"Class: Stepper # Renderer . Component .Stepper Hierarchy # Component < StepperProps , {}> \u21b3 Stepper Table of contents # Constructors # constructor Methods # render Constructors # constructor # \u2022 new Stepper ( props ) Parameters # Name Type props StepperProps | Readonly < StepperProps > Inherited from # React.Component.constructor \u2022 new Stepper ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props StepperProps context any Inherited from # React.Component.constructor Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: Stepper"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#class-stepper","text":"Renderer . Component .Stepper","title":"Class: Stepper"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#hierarchy","text":"Component < StepperProps , {}> \u21b3 Stepper","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#constructor","text":"\u2022 new Stepper ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/","text":"Class: SubTitle # Renderer . Component .SubTitle Hierarchy # Component < SubTitleProps > \u21b3 SubTitle Table of contents # Constructors # constructor Methods # render Constructors # constructor # \u2022 new SubTitle ( props ) Parameters # Name Type props SubTitleProps | Readonly < SubTitleProps > Inherited from # React.Component.constructor \u2022 new SubTitle ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SubTitleProps context any Inherited from # React.Component.constructor Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: SubTitle"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#class-subtitle","text":"Renderer . Component .SubTitle","title":"Class: SubTitle"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#hierarchy","text":"Component < SubTitleProps > \u21b3 SubTitle","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#constructor","text":"\u2022 new SubTitle ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Tab/","text":"Class: Tab # Renderer . Component .Tab Type parameters # Name D Hierarchy # PureComponent < TabProps < D >> \u21b3 Tab Table of contents # Constructors # constructor Properties # context ref contextType Accessors # isActive Methods # componentDidMount focus onClick onFocus onKeyDown render scrollIntoView Constructors # constructor # \u2022 new Tab < D >( props ) Type parameters # Name D Parameters # Name Type props TabProps < D > Overrides # React.PureComponent\\>.constructor Properties # context # \u2022 context : TabsContextValue < D > Overrides # React.PureComponent.context ref # \u2022 ref : RefObject < HTMLDivElement > contextType # \u25aa Static contextType : Context < TabsContextValue < unknown >> Overrides # React.PureComponent.contextType Accessors # isActive # \u2022 get isActive (): boolean Returns # boolean Methods # componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.PureComponent.componentDidMount focus # \u25b8 focus (): void Returns # void onClick # \u25b8 onClick ( evt ): void Parameters # Name Type evt MouseEvent < HTMLElement , MouseEvent > Returns # void onFocus # \u25b8 onFocus ( evt ): void Parameters # Name Type evt FocusEvent < HTMLElement , Element > Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent < HTMLElement > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render scrollIntoView # \u25b8 scrollIntoView (): void Returns # void","title":"Class: Tab"},{"location":"extensions/api/classes/Renderer.Component.Tab/#class-tabd","text":"Renderer . Component .Tab","title":"Class: Tab<D>"},{"location":"extensions/api/classes/Renderer.Component.Tab/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.Tab/#hierarchy","text":"PureComponent < TabProps < D >> \u21b3 Tab","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Tab/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Tab/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tab/#properties","text":"context ref contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tab/#accessors","text":"isActive","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Tab/#methods","text":"componentDidMount focus onClick onFocus onKeyDown render scrollIntoView","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tab/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tab/#constructor","text":"\u2022 new Tab < D >( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Tab/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tab/#context","text":"\u2022 context : TabsContextValue < D >","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Tab/#ref","text":"\u2022 ref : RefObject < HTMLDivElement >","title":"ref"},{"location":"extensions/api/classes/Renderer.Component.Tab/#contexttype","text":"\u25aa Static contextType : Context < TabsContextValue < unknown >>","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Tab/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Tab/#isactive","text":"\u2022 get isActive (): boolean","title":"isActive"},{"location":"extensions/api/classes/Renderer.Component.Tab/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tab/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Tab/#focus","text":"\u25b8 focus (): void","title":"focus"},{"location":"extensions/api/classes/Renderer.Component.Tab/#onclick","text":"\u25b8 onClick ( evt ): void","title":"onClick"},{"location":"extensions/api/classes/Renderer.Component.Tab/#onfocus","text":"\u25b8 onFocus ( evt ): void","title":"onFocus"},{"location":"extensions/api/classes/Renderer.Component.Tab/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/Renderer.Component.Tab/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Tab/#scrollintoview","text":"\u25b8 scrollIntoView (): void","title":"scrollIntoView"},{"location":"extensions/api/classes/Renderer.Component.TableCell/","text":"Class: TableCell # Renderer . Component .TableCell Hierarchy # Component < TableCellProps > \u21b3 TableCell Table of contents # Constructors # constructor Methods # onClick render renderCheckbox renderSortIcon Constructors # constructor # \u2022 new TableCell ( props ) Parameters # Name Type props TableCellProps Overrides # React.Component.constructor Methods # onClick # \u25b8 onClick ( evt ): void Parameters # Name Type evt MouseEvent < HTMLDivElement , MouseEvent > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render renderCheckbox # \u25b8 renderCheckbox (): null | Element Returns # null | Element renderSortIcon # \u25b8 renderSortIcon (): null | Element Returns # null | Element","title":"Class: TableCell"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#class-tablecell","text":"Renderer . Component .TableCell","title":"Class: TableCell"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#hierarchy","text":"Component < TableCellProps > \u21b3 TableCell","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#methods","text":"onClick render renderCheckbox renderSortIcon","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#constructor","text":"\u2022 new TableCell ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#onclick","text":"\u25b8 onClick ( evt ): void","title":"onClick"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#rendercheckbox","text":"\u25b8 renderCheckbox (): null | Element","title":"renderCheckbox"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#rendersorticon","text":"\u25b8 renderSortIcon (): null | Element","title":"renderSortIcon"},{"location":"extensions/api/classes/Renderer.Component.TableHead/","text":"Class: TableHead # Renderer . Component .TableHead Hierarchy # Component < TableHeadProps > \u21b3 TableHead Table of contents # Constructors # constructor Properties # defaultProps Methods # render Constructors # constructor # \u2022 new TableHead ( props ) Parameters # Name Type props TableHeadProps | Readonly < TableHeadProps > Inherited from # React.Component.constructor \u2022 new TableHead ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props TableHeadProps context any Inherited from # React.Component.constructor Properties # defaultProps # \u25aa Static defaultProps : TableHeadProps Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: TableHead"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#class-tablehead","text":"Renderer . Component .TableHead","title":"Class: TableHead"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#hierarchy","text":"Component < TableHeadProps > \u21b3 TableHead","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#properties","text":"defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#constructor","text":"\u2022 new TableHead ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#defaultprops","text":"\u25aa Static defaultProps : TableHeadProps","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.TableRow/","text":"Class: TableRow # Renderer . Component .TableRow Type parameters # Name Item Hierarchy # Component < TableRowProps < Item >> \u21b3 TableRow Table of contents # Constructors # constructor Methods # render Constructors # constructor # \u2022 new TableRow < Item >( props ) Type parameters # Name Item Parameters # Name Type props TableRowProps < Item > | Readonly < TableRowProps < Item >> Inherited from # React.Component>.constructor \u2022 new TableRow < Item >( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Type parameters # Name Item Parameters # Name Type props TableRowProps < Item > context any Inherited from # React.Component>.constructor Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: TableRow"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#class-tablerowitem","text":"Renderer . Component .TableRow","title":"Class: TableRow<Item>"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#type-parameters","text":"Name Item","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#hierarchy","text":"Component < TableRowProps < Item >> \u21b3 TableRow","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#constructor","text":"\u2022 new TableRow < Item >( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Tabs/","text":"Class: Tabs # Renderer . Component .Tabs Type parameters # Name D Hierarchy # PureComponent < TabsProps < D >> \u21b3 Tabs Table of contents # Constructors # constructor Properties # elem Methods # render Constructors # constructor # \u2022 new Tabs < D >( props ) Type parameters # Name D Parameters # Name Type props TabsProps < D > | Readonly < TabsProps < D >> Inherited from # React.PureComponent>.constructor \u2022 new Tabs < D >( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Type parameters # Name D Parameters # Name Type props TabsProps < D > context any Inherited from # React.PureComponent>.constructor Properties # elem # \u2022 elem : null | HTMLDivElement Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render","title":"Class: Tabs"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#class-tabsd","text":"Renderer . Component .Tabs","title":"Class: Tabs<D>"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#hierarchy","text":"PureComponent < TabsProps < D >> \u21b3 Tabs","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#properties","text":"elem","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#constructor","text":"\u2022 new Tabs < D >( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#elem","text":"\u2022 elem : null | HTMLDivElement","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/","text":"Class: TerminalStore # Renderer . Component .TerminalStore Table of contents # Constructors # constructor Methods # createInstance getInstance resetInstance Constructors # constructor # \u2022 new TerminalStore () Methods # createInstance # \u25b8 Static createInstance (): TerminalStore & { sendCommand : SendCommand } Returns # TerminalStore & { sendCommand : SendCommand } getInstance # \u25b8 Static getInstance (): TerminalStore & { sendCommand : SendCommand } Returns # TerminalStore & { sendCommand : SendCommand } resetInstance # \u25b8 Static resetInstance (): void Returns # void","title":"Class: TerminalStore"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#class-terminalstore","text":"Renderer . Component .TerminalStore","title":"Class: TerminalStore"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#methods","text":"createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructor","text":"\u2022 new TerminalStore ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#createinstance","text":"\u25b8 Static createInstance (): TerminalStore & { sendCommand : SendCommand }","title":"createInstance"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#getinstance","text":"\u25b8 Static getInstance (): TerminalStore & { sendCommand : SendCommand }","title":"getInstance"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#resetinstance","text":"\u25b8 Static resetInstance (): void","title":"resetInstance"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/","text":"Class: Tooltip # Renderer . Component .Tooltip Hierarchy # Component < TooltipProps > \u21b3 Tooltip Table of contents # Constructors # constructor Properties # activePosition elem isContentVisible isVisible defaultProps Accessors # hoverTarget targetElem Methods # componentDidMount componentDidUpdate componentWillUnmount getPosition onEnterTarget onLeaveTarget refreshPosition render setPosition Constructors # constructor # \u2022 new Tooltip ( props ) Parameters # Name Type props TooltipProps Overrides # React.Component.constructor Properties # activePosition # \u2022 Optional activePosition : TooltipPosition elem # \u2022 elem : null | HTMLDivElement isContentVisible # \u2022 isContentVisible : boolean isVisible # \u2022 isVisible : boolean defaultProps # \u25aa Static defaultProps : object Accessors # hoverTarget # \u2022 get hoverTarget (): null | HTMLElement Returns # null | HTMLElement targetElem # \u2022 get targetElem (): null | HTMLElement Returns # null | HTMLElement Methods # componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 componentDidUpdate (): void Returns # void Overrides # React.Component.componentDidUpdate componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount getPosition # \u25b8 Protected getPosition ( position , tooltipBounds , targetBounds ): Object Parameters # Name Type position TooltipPosition tooltipBounds DOMRect targetBounds DOMRect Returns # Object Name Type bottom number left number right number top number onEnterTarget # \u25b8 Protected onEnterTarget (): void Returns # void onLeaveTarget # \u25b8 Protected onLeaveTarget (): void Returns # void refreshPosition # \u25b8 refreshPosition (): void Returns # void render # \u25b8 render (): null | Element Returns # null | Element Overrides # React.Component.render setPosition # \u25b8 Protected setPosition ( elem , pos ): void Parameters # Name Type elem HTMLDivElement pos Object pos.left number pos.top number Returns # void","title":"Class: Tooltip"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#class-tooltip","text":"Renderer . Component .Tooltip","title":"Class: Tooltip"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#hierarchy","text":"Component < TooltipProps > \u21b3 Tooltip","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#properties","text":"activePosition elem isContentVisible isVisible defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#accessors","text":"hoverTarget targetElem","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#methods","text":"componentDidMount componentDidUpdate componentWillUnmount getPosition onEnterTarget onLeaveTarget refreshPosition render setPosition","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#constructor","text":"\u2022 new Tooltip ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#activeposition","text":"\u2022 Optional activePosition : TooltipPosition","title":"activePosition"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#elem","text":"\u2022 elem : null | HTMLDivElement","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#iscontentvisible","text":"\u2022 isContentVisible : boolean","title":"isContentVisible"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#isvisible","text":"\u2022 isVisible : boolean","title":"isVisible"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#hovertarget","text":"\u2022 get hoverTarget (): null | HTMLElement","title":"hoverTarget"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#targetelem","text":"\u2022 get targetElem (): null | HTMLElement","title":"targetElem"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#componentdidupdate","text":"\u25b8 componentDidUpdate (): void","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#getposition","text":"\u25b8 Protected getPosition ( position , tooltipBounds , targetBounds ): Object","title":"getPosition"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#onentertarget","text":"\u25b8 Protected onEnterTarget (): void","title":"onEnterTarget"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#onleavetarget","text":"\u25b8 Protected onLeaveTarget (): void","title":"onLeaveTarget"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#refreshposition","text":"\u25b8 refreshPosition (): void","title":"refreshPosition"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#render","text":"\u25b8 render (): null | Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#setposition","text":"\u25b8 Protected setPosition ( elem , pos ): void","title":"setPosition"},{"location":"extensions/api/classes/Renderer.Component.Wizard/","text":"Class: Wizard # Renderer . Component .Wizard Type parameters # Name D Hierarchy # Component < WizardProps < D >, State > \u21b3 Wizard Table of contents # Constructors # constructor Properties # firstStep isFirstStep isLastStep lastStep nextStep prevStep state Accessors # step steps Methods # getValidStep render Constructors # constructor # \u2022 new Wizard < D >( props ) Type parameters # Name D Parameters # Name Type props WizardProps < D > | Readonly < WizardProps < D >> Inherited from # React.Component, State>.constructor \u2022 new Wizard < D >( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Type parameters # Name D Parameters # Name Type props WizardProps < D > context any Inherited from # React.Component, State>.constructor Properties # firstStep # \u2022 firstStep : () => any Type declaration # \u25b8 (): any Returns # any isFirstStep # \u2022 isFirstStep : () => boolean Type declaration # \u25b8 (): boolean Returns # boolean isLastStep # \u2022 isLastStep : () => boolean Type declaration # \u25b8 (): boolean Returns # boolean lastStep # \u2022 lastStep : () => any Type declaration # \u25b8 (): any Returns # any nextStep # \u2022 nextStep : () => any Type declaration # \u25b8 (): any Returns # any prevStep # \u2022 prevStep : () => any Type declaration # \u25b8 (): any Returns # any state # \u2022 state : State Overrides # React.Component.state Accessors # step # \u2022 get step (): number Returns # number \u2022 set step ( step ): void Parameters # Name Type step number Returns # void steps # \u2022 get steps (): ReactElement < WizardStepProps < D >, string | JSXElementConstructor < any >>[] Returns # ReactElement < WizardStepProps < D >, string | JSXElementConstructor < any >>[] Methods # getValidStep # \u25b8 Protected getValidStep ( step ): number Parameters # Name Type step number Returns # number render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: Wizard"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#class-wizardd","text":"Renderer . Component .Wizard","title":"Class: Wizard<D>"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#hierarchy","text":"Component < WizardProps < D >, State > \u21b3 Wizard","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#properties","text":"firstStep isFirstStep isLastStep lastStep nextStep prevStep state","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#accessors","text":"step steps","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#methods","text":"getValidStep render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#constructor","text":"\u2022 new Wizard < D >( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#firststep","text":"\u2022 firstStep : () => any","title":"firstStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#isfirststep","text":"\u2022 isFirstStep : () => boolean","title":"isFirstStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#islaststep","text":"\u2022 isLastStep : () => boolean","title":"isLastStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#laststep","text":"\u2022 lastStep : () => any","title":"lastStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#nextstep","text":"\u2022 nextStep : () => any","title":"nextStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#prevstep","text":"\u2022 prevStep : () => any","title":"prevStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#state","text":"\u2022 state : State","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#step","text":"\u2022 get step (): number","title":"step"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#steps","text":"\u2022 get steps (): ReactElement < WizardStepProps < D >, string | JSXElementConstructor < any >>[]","title":"steps"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#getvalidstep","text":"\u25b8 Protected getValidStep ( step ): number","title":"getValidStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/","text":"Class: WizardLayout # Renderer . Component .WizardLayout Hierarchy # Component < WizardLayoutProps > \u21b3 WizardLayout Table of contents # Constructors # constructor Methods # render Constructors # constructor # \u2022 new WizardLayout ( props ) Parameters # Name Type props WizardLayoutProps | Readonly < WizardLayoutProps > Inherited from # React.Component.constructor \u2022 new WizardLayout ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props WizardLayoutProps context any Inherited from # React.Component.constructor Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: WizardLayout"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#class-wizardlayout","text":"Renderer . Component .WizardLayout","title":"Class: WizardLayout"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#hierarchy","text":"Component < WizardLayoutProps > \u21b3 WizardLayout","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#constructor","text":"\u2022 new WizardLayout ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/","text":"Class: WizardStep # Renderer . Component .WizardStep Type parameters # Name D Hierarchy # Component < WizardStepProps < D >, WizardStepState > \u21b3 WizardStep Table of contents # Constructors # constructor Properties # next prev state submit defaultProps Methods # componentWillUnmount keyDown render renderLoading Constructors # constructor # \u2022 new WizardStep < D >( props ) Type parameters # Name D Parameters # Name Type props WizardStepProps < D > | Readonly < WizardStepProps < D >> Inherited from # React.Component, WizardStepState>.constructor \u2022 new WizardStep < D >( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Type parameters # Name D Parameters # Name Type props WizardStepProps < D > context any Inherited from # React.Component, WizardStepState>.constructor Properties # next # \u2022 next : () => void Type declaration # \u25b8 (): void Returns # void prev # \u2022 prev : () => void Type declaration # \u25b8 (): void Returns # void state # \u2022 state : WizardStepState Overrides # React.Component.state submit # \u2022 submit : DebouncedFunc <() => void > defaultProps # \u25aa Static defaultProps : WizardStepProps < any > Methods # componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount keyDown # \u25b8 keyDown ( evt ): void Parameters # Name Type evt KeyboardEvent < HTMLElement > Returns # void render # \u25b8 render (): null | Element Returns # null | Element Overrides # React.Component.render renderLoading # \u25b8 renderLoading (): Element Returns # Element","title":"Class: WizardStep"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#class-wizardstepd","text":"Renderer . Component .WizardStep","title":"Class: WizardStep<D>"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#hierarchy","text":"Component < WizardStepProps < D >, WizardStepState > \u21b3 WizardStep","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#properties","text":"next prev state submit defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#methods","text":"componentWillUnmount keyDown render renderLoading","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#constructor","text":"\u2022 new WizardStep < D >( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#next","text":"\u2022 next : () => void","title":"next"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#prev","text":"\u2022 prev : () => void","title":"prev"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#state","text":"\u2022 state : WizardStepState","title":"state"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#submit","text":"\u2022 submit : DebouncedFunc <() => void >","title":"submit"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#defaultprops","text":"\u25aa Static defaultProps : WizardStepProps < any >","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#keydown","text":"\u25b8 keyDown ( evt ): void","title":"keyDown"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#render","text":"\u25b8 render (): null | Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#renderloading","text":"\u25b8 renderLoading (): Element","title":"renderLoading"},{"location":"extensions/api/classes/Renderer.Ipc/","text":"Class: Ipc # Renderer .Ipc Hierarchy # IpcRegistrar \u21b3 Ipc Table of contents # Constructors # constructor Properties # [IpcPrefix] extension Methods # broadcast invoke listen createInstance getInstance resetInstance Constructors # constructor # \u2022 new Ipc ( extension ) Parameters # Name Type extension LensExtension Overrides # IpcRegistrar.constructor Properties # [IpcPrefix] # \u2022 Readonly [IpcPrefix] : string Inherited from # IpcRegistrar.__@IpcPrefix@1575 extension # \u2022 Protected Readonly extension : LensExtension < LensExtensionDependencies > Inherited from # IpcRegistrar.extension Methods # broadcast # \u25b8 broadcast ( channel , ...args ): void Parameters # Name Type Description channel string The channel to broadcast to your whole extension, both main and renderer ...args any [] The arguments passed to all listeners Returns # void Inherited from # IpcRegistrar.broadcast invoke # \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. Parameters # Name Type Description channel string The channel to invoke a RPC on ...args any [] The arguments to pass to the RPC Returns # Promise < any > A promise of the resulting value listen # \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. Parameters # Name Type Description 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 Returns # Disposer An optional disposer, Lens will cleanup even if this is not called createInstance # \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. Type parameters # Name Type T extends Singleton < T > R extends any [] Parameters # Name Type Description this StaticThis < T , R > Implicit argument that is the child class type ...args R The constructor arguments for the child class Returns # T An instance of the child class Inherited from # IpcRegistrar.createInstance getInstance # \u25b8 Static getInstance < T , R >( this , strict? ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R extends any [] Parameters # 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 Returns # T An instance of the child class Inherited from # IpcRegistrar.getInstance \u25b8 Static getInstance < T , R >( this , strict ): undefined | T Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > strict false Returns # undefined | T Inherited from # IpcRegistrar.getInstance resetInstance # \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. Returns # void Inherited from # IpcRegistrar.resetInstance","title":"Class: Ipc"},{"location":"extensions/api/classes/Renderer.Ipc/#class-ipc","text":"Renderer .Ipc","title":"Class: Ipc"},{"location":"extensions/api/classes/Renderer.Ipc/#hierarchy","text":"IpcRegistrar \u21b3 Ipc","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Ipc/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Ipc/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Ipc/#properties","text":"[IpcPrefix] extension","title":"Properties"},{"location":"extensions/api/classes/Renderer.Ipc/#methods","text":"broadcast invoke listen createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/Renderer.Ipc/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Ipc/#constructor","text":"\u2022 new Ipc ( extension )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Ipc/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Ipc/#ipcprefix","text":"\u2022 Readonly [IpcPrefix] : string","title":"[IpcPrefix]"},{"location":"extensions/api/classes/Renderer.Ipc/#extension","text":"\u2022 Protected Readonly extension : LensExtension < LensExtensionDependencies >","title":"extension"},{"location":"extensions/api/classes/Renderer.Ipc/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Ipc/#broadcast","text":"\u25b8 broadcast ( channel , ...args ): void","title":"broadcast"},{"location":"extensions/api/classes/Renderer.Ipc/#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.","title":"invoke"},{"location":"extensions/api/classes/Renderer.Ipc/#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.","title":"listen"},{"location":"extensions/api/classes/Renderer.Ipc/#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.","title":"createInstance"},{"location":"extensions/api/classes/Renderer.Ipc/#getinstance","text":"\u25b8 Static getInstance < T , R >( this , strict? ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/Renderer.Ipc/#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.","title":"resetInstance"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/","text":"Class: CRDResourceStore # Renderer . K8sApi .CRDResourceStore Type parameters # Name Type K extends KubeObject Hierarchy # KubeObjectStore < K , KubeApi < K >> \u21b3 CRDResourceStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new CRDResourceStore < K >( deps , api ) Type parameters # Name Type K extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , K > Parameters # Name Type deps KubeObjectStoreDependencies api KubeApi < K , KubeJsonApiDataFor < K >> Overrides # KubeObjectStore\\>.constructor Properties # api # \u2022 Readonly api : KubeApi < K , KubeJsonApiDataFor < K >> Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : K ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item K Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiDataFor < K > extends KubeJsonApiDataFor < K > ? KubeJsonApiDataFor < K > : never >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < K > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < K , void , undefined > Returns # Generator < K , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string data? PartialDeep < K > Returns # Promise < K > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | K > Parameters # Name Type params Object params.name string params.namespace? string data? PartialDeep < K > Returns # Promise < null | K > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): K [] Parameters # Name Type items K [] Returns # K [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): K [] Parameters # Name Type namespace string | string [] strict? boolean Returns # K [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | K Parameters # Name Type id string Returns # undefined | K Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): K [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # K [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | K Parameters # Name Type name string namespace? string Returns # undefined | K Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | K Parameters # Name Type path string Returns # undefined | K Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): K [] Returns # K [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item K Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? K [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < K > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | K []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | K []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < K > Parameters # Name Type resourcePath string Returns # Promise < K > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | K > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | K > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < K []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < K []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): K [] Parameters # Name Type partialItems K [] \u00abdestructured\u00bb MergeItemsOptions Returns # K [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < K > Parameters # Name Type item K patch Patch Returns # Promise < K > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): K [] Parameters # Name Type items K [] Returns # K [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | K []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | K []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item K Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item K request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items K [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item K Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # K [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item K Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? K [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item K Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < K > Parameters # Name Type item K data PartialDeep < K > Returns # Promise < K > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < K > Parameters # Name Type item K request () => Promise < K > Returns # Promise < K > Inherited from # KubeObjectStore.updateItem","title":"Class: CRDResourceStore"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#class-crdresourcestorek","text":"Renderer . K8sApi .CRDResourceStore","title":"Class: CRDResourceStore<K>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#type-parameters","text":"Name Type K extends KubeObject","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#hierarchy","text":"KubeObjectStore < K , KubeApi < K >> \u21b3 CRDResourceStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#constructor","text":"\u2022 new CRDResourceStore < K >( deps , api )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#api","text":"\u2022 Readonly api : KubeApi < K , KubeJsonApiDataFor < K >>","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : K ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiDataFor < K > extends KubeJsonApiDataFor < K > ? KubeJsonApiDataFor < K > : never >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#items","text":"\u2022 items : IObservableArray < K >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#iterator","text":"\u25b8 [iterator] (): Generator < K , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#create","text":"\u25b8 create ( params , data? ): Promise < K >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | K >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): K []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): K []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbyid","text":"\u25b8 getById ( id ): undefined | K","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): K []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | K","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | K","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getitems","text":"\u25b8 getItems (): K []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#load","text":"\u25b8 load ( params ): Promise < K >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | K []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < K >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | K >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < K []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): K []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < K >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): K []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | K []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#update","text":"\u25b8 update ( item , data ): Promise < K >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < K >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/","text":"Class: CRDStore # Renderer . K8sApi .CRDStore Hierarchy # KubeObjectStore < CustomResourceDefinition , CustomResourceDefinitionApi > \u21b3 CRDStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems groups query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getByGroup getById getByLabel getByName getByObject getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new CRDStore ( dependencies , api , opts? ) Parameters # Name Type dependencies CustomResourceDefinitionStoreDependencies api CustomResourceDefinitionApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : CustomResourceDefinitionApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : CustomResourceDefinition ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item CustomResourceDefinition Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : CustomResourceDefinitionStoreDependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , CustomResourceDefinitionStatus , CustomResourceDefinitionSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < CustomResourceDefinition > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems groups # \u2022 get groups (): Record < string , CustomResourceDefinition []> Returns # Record < string , CustomResourceDefinition []> query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < CustomResourceDefinition , void , undefined > Returns # Generator < CustomResourceDefinition , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < CustomResourceDefinition > Returns # Promise < null | CustomResourceDefinition > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): CustomResourceDefinition [] Parameters # Name Type items CustomResourceDefinition [] Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): CustomResourceDefinition [] Parameters # Name Type namespace string | string [] strict? boolean Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore.getAllByNs getByGroup # \u25b8 getByGroup ( group , pluralName ): undefined | CustomResourceDefinition Parameters # Name Type group string pluralName string Returns # undefined | CustomResourceDefinition getById # \u25b8 getById ( id ): undefined | CustomResourceDefinition Parameters # Name Type id string Returns # undefined | CustomResourceDefinition Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): CustomResourceDefinition [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | CustomResourceDefinition Parameters # Name Type name string namespace? string Returns # undefined | CustomResourceDefinition Inherited from # KubeObjectStore.getByName getByObject # \u25b8 getByObject ( obj ): undefined | CustomResourceDefinition Parameters # Name Type obj KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # undefined | CustomResourceDefinition getByPath # \u25b8 getByPath ( path ): undefined | CustomResourceDefinition Parameters # Name Type path string Returns # undefined | CustomResourceDefinition Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): CustomResourceDefinition [] Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item CustomResourceDefinition Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? CustomResourceDefinition [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | CustomResourceDefinition []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | CustomResourceDefinition []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < CustomResourceDefinition > Parameters # Name Type resourcePath string Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | CustomResourceDefinition > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < CustomResourceDefinition []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < CustomResourceDefinition []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): CustomResourceDefinition [] Parameters # Name Type partialItems CustomResourceDefinition [] \u00abdestructured\u00bb MergeItemsOptions Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < CustomResourceDefinition > Parameters # Name Type item CustomResourceDefinition patch Patch Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): CustomResourceDefinition [] Parameters # Name Type items CustomResourceDefinition [] Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | CustomResourceDefinition []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | CustomResourceDefinition []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item CustomResourceDefinition Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item CustomResourceDefinition request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items CustomResourceDefinition [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item CustomResourceDefinition Returns # void Inherited from # KubeObjectStore.select sortItems # \u25b8 Protected sortItems ( items ): CustomResourceDefinition [] Parameters # Name Type items CustomResourceDefinition [] Returns # CustomResourceDefinition [] Overrides # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item CustomResourceDefinition Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? CustomResourceDefinition [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item CustomResourceDefinition Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < CustomResourceDefinition > Parameters # Name Type item CustomResourceDefinition data PartialObjectDeep < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < CustomResourceDefinition > Parameters # Name Type item CustomResourceDefinition request () => Promise < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore.updateItem","title":"Class: CRDStore"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#class-crdstore","text":"Renderer . K8sApi .CRDStore","title":"Class: CRDStore"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#hierarchy","text":"KubeObjectStore < CustomResourceDefinition , CustomResourceDefinitionApi > \u21b3 CRDStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#accessors","text":"contextItems groups query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getByGroup getById getByLabel getByName getByObject getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#constructor","text":"\u2022 new CRDStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#api","text":"\u2022 Readonly api : CustomResourceDefinitionApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : CustomResourceDefinition ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#dependencies","text":"\u2022 Protected Readonly dependencies : CustomResourceDefinitionStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , CustomResourceDefinitionStatus , CustomResourceDefinitionSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#items","text":"\u2022 items : IObservableArray < CustomResourceDefinition >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#groups","text":"\u2022 get groups (): Record < string , CustomResourceDefinition []>","title":"groups"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#iterator","text":"\u25b8 [iterator] (): Generator < CustomResourceDefinition , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#create","text":"\u25b8 create ( params , data? ): Promise < CustomResourceDefinition >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | CustomResourceDefinition >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): CustomResourceDefinition []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): CustomResourceDefinition []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbygroup","text":"\u25b8 getByGroup ( group , pluralName ): undefined | CustomResourceDefinition","title":"getByGroup"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyid","text":"\u25b8 getById ( id ): undefined | CustomResourceDefinition","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): CustomResourceDefinition []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | CustomResourceDefinition","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyobject","text":"\u25b8 getByObject ( obj ): undefined | CustomResourceDefinition","title":"getByObject"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | CustomResourceDefinition","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getitems","text":"\u25b8 getItems (): CustomResourceDefinition []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#load","text":"\u25b8 load ( params ): Promise < CustomResourceDefinition >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | CustomResourceDefinition []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < CustomResourceDefinition >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | CustomResourceDefinition >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < CustomResourceDefinition []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): CustomResourceDefinition []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < CustomResourceDefinition >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): CustomResourceDefinition []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | CustomResourceDefinition []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#sortitems","text":"\u25b8 Protected sortItems ( items ): CustomResourceDefinition []","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#update","text":"\u25b8 update ( item , data ): Promise < CustomResourceDefinition >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < CustomResourceDefinition >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/","text":"Class: ConfigMapsStore # Renderer . K8sApi .ConfigMapsStore Hierarchy # KubeObjectStore < ConfigMap , ConfigMapApi , ConfigMapData > \u21b3 ConfigMapsStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ConfigMapsStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api ConfigMapApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : ConfigMapApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : ConfigMap ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item ConfigMap Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < ConfigMapData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < ConfigMap > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < ConfigMap , void , undefined > Returns # Generator < ConfigMap , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < ConfigMap > Returns # Promise < ConfigMap > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < ConfigMap > Returns # Promise < null | ConfigMap > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): ConfigMap [] Parameters # Name Type items ConfigMap [] Returns # ConfigMap [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): ConfigMap [] Parameters # Name Type namespace string | string [] strict? boolean Returns # ConfigMap [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | ConfigMap Parameters # Name Type id string Returns # undefined | ConfigMap Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): ConfigMap [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # ConfigMap [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | ConfigMap Parameters # Name Type name string namespace? string Returns # undefined | ConfigMap Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | ConfigMap Parameters # Name Type path string Returns # undefined | ConfigMap Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): ConfigMap [] Returns # ConfigMap [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item ConfigMap Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? ConfigMap [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ConfigMap > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ConfigMap []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | ConfigMap []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < ConfigMap > Parameters # Name Type resourcePath string Returns # Promise < ConfigMap > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | ConfigMap > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ConfigMap []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < ConfigMap []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ConfigMap [] Parameters # Name Type partialItems ConfigMap [] \u00abdestructured\u00bb MergeItemsOptions Returns # ConfigMap [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < ConfigMap > Parameters # Name Type item ConfigMap patch Patch Returns # Promise < ConfigMap > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): ConfigMap [] Parameters # Name Type items ConfigMap [] Returns # ConfigMap [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | ConfigMap []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | ConfigMap []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item ConfigMap Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item ConfigMap request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items ConfigMap [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item ConfigMap Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # ConfigMap [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item ConfigMap Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? ConfigMap [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item ConfigMap Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < ConfigMap > Parameters # Name Type item ConfigMap data PartialObjectDeep < ConfigMap > Returns # Promise < ConfigMap > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < ConfigMap > Parameters # Name Type item ConfigMap request () => Promise < ConfigMap > Returns # Promise < ConfigMap > Inherited from # KubeObjectStore.updateItem","title":"Class: ConfigMapsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#class-configmapsstore","text":"Renderer . K8sApi .ConfigMapsStore","title":"Class: ConfigMapsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#hierarchy","text":"KubeObjectStore < ConfigMap , ConfigMapApi , ConfigMapData > \u21b3 ConfigMapsStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#constructor","text":"\u2022 new ConfigMapsStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#api","text":"\u2022 Readonly api : ConfigMapApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : ConfigMap ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < ConfigMapData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#items","text":"\u2022 items : IObservableArray < ConfigMap >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#iterator","text":"\u25b8 [iterator] (): Generator < ConfigMap , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#create","text":"\u25b8 create ( params , data? ): Promise < ConfigMap >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | ConfigMap >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): ConfigMap []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): ConfigMap []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbyid","text":"\u25b8 getById ( id ): undefined | ConfigMap","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): ConfigMap []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | ConfigMap","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | ConfigMap","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getitems","text":"\u25b8 getItems (): ConfigMap []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#load","text":"\u25b8 load ( params ): Promise < ConfigMap >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ConfigMap []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < ConfigMap >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | ConfigMap >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ConfigMap []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ConfigMap []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < ConfigMap >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): ConfigMap []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | ConfigMap []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#update","text":"\u25b8 update ( item , data ): Promise < ConfigMap >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < ConfigMap >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/","text":"Class: CronJobStore # Renderer . K8sApi .CronJobStore Hierarchy # KubeObjectStore < CronJob , CronJobApi > \u21b3 CronJobStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getActiveJobsNum getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new CronJobStore ( dependencies , api , opts? ) Parameters # Name Type dependencies Dependencies api CronJobApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : CronJobApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : CronJob ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item CronJob Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : Dependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , CronJobStatus , CronJobSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < CronJob > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < CronJob , void , undefined > Returns # Generator < CronJob , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < CronJob > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < CronJob > Returns # Promise < CronJob > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | CronJob > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < CronJob > Returns # Promise < null | CronJob > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): CronJob [] Parameters # Name Type items CronJob [] Returns # CronJob [] Inherited from # KubeObjectStore.filterItemsOnLoad getActiveJobsNum # \u25b8 getActiveJobsNum ( cronJob ): number Parameters # Name Type cronJob CronJob Returns # number getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): CronJob [] Parameters # Name Type namespace string | string [] strict? boolean Returns # CronJob [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | CronJob Parameters # Name Type id string Returns # undefined | CronJob Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): CronJob [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # CronJob [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | CronJob Parameters # Name Type name string namespace? string Returns # undefined | CronJob Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | CronJob Parameters # Name Type path string Returns # undefined | CronJob Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): CronJob [] Returns # CronJob [] Inherited from # KubeObjectStore.getItems getStatuses # \u25b8 getStatuses ( cronJobs? ): Object Parameters # Name Type cronJobs? CronJob [] Returns # Object Name Type scheduled number suspended number getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item CronJob Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? CronJob [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < CronJob > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < CronJob > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | CronJob []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | CronJob []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < CronJob > Parameters # Name Type resourcePath string Returns # Promise < CronJob > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | CronJob > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | CronJob > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < CronJob []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < CronJob []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): CronJob [] Parameters # Name Type partialItems CronJob [] \u00abdestructured\u00bb MergeItemsOptions Returns # CronJob [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < CronJob > Parameters # Name Type item CronJob patch Patch Returns # Promise < CronJob > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): CronJob [] Parameters # Name Type items CronJob [] Returns # CronJob [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | CronJob []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | CronJob []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item CronJob Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item CronJob request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items CronJob [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item CronJob Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # CronJob [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item CronJob Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? CronJob [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item CronJob Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < CronJob > Parameters # Name Type item CronJob data PartialObjectDeep < CronJob > Returns # Promise < CronJob > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < CronJob > Parameters # Name Type item CronJob request () => Promise < CronJob > Returns # Promise < CronJob > Inherited from # KubeObjectStore.updateItem","title":"Class: CronJobStore"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#class-cronjobstore","text":"Renderer . K8sApi .CronJobStore","title":"Class: CronJobStore"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#hierarchy","text":"KubeObjectStore < CronJob , CronJobApi > \u21b3 CronJobStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getActiveJobsNum getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#constructor","text":"\u2022 new CronJobStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#api","text":"\u2022 Readonly api : CronJobApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : CronJob ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#dependencies","text":"\u2022 Protected Readonly dependencies : Dependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , CronJobStatus , CronJobSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#items","text":"\u2022 items : IObservableArray < CronJob >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#iterator","text":"\u25b8 [iterator] (): Generator < CronJob , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#create","text":"\u25b8 create ( params , data? ): Promise < CronJob >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | CronJob >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): CronJob []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getactivejobsnum","text":"\u25b8 getActiveJobsNum ( cronJob ): number","title":"getActiveJobsNum"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): CronJob []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbyid","text":"\u25b8 getById ( id ): undefined | CronJob","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): CronJob []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | CronJob","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | CronJob","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getitems","text":"\u25b8 getItems (): CronJob []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getstatuses","text":"\u25b8 getStatuses ( cronJobs? ): Object","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#load","text":"\u25b8 load ( params ): Promise < CronJob >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | CronJob []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < CronJob >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | CronJob >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < CronJob []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): CronJob []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < CronJob >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): CronJob []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | CronJob []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#update","text":"\u25b8 update ( item , data ): Promise < CronJob >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < CronJob >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/","text":"Class: DaemonSetStore # Renderer . K8sApi .DaemonSetStore Hierarchy # KubeObjectStore < DaemonSet , DaemonSetApi > \u21b3 DaemonSetStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new DaemonSetStore ( dependencies , api , opts? ) Parameters # Name Type dependencies DaemonSetStoreDependencies api DaemonSetApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : DaemonSetApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : DaemonSet ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item DaemonSet Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : DaemonSetStoreDependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , DaemonSetStatus , DaemonSetSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < DaemonSet > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < DaemonSet , void , undefined > Returns # Generator < DaemonSet , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < DaemonSet > Returns # Promise < DaemonSet > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < DaemonSet > Returns # Promise < null | DaemonSet > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): DaemonSet [] Parameters # Name Type items DaemonSet [] Returns # DaemonSet [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): DaemonSet [] Parameters # Name Type namespace string | string [] strict? boolean Returns # DaemonSet [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | DaemonSet Parameters # Name Type id string Returns # undefined | DaemonSet Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): DaemonSet [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # DaemonSet [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | DaemonSet Parameters # Name Type name string namespace? string Returns # undefined | DaemonSet Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | DaemonSet Parameters # Name Type path string Returns # undefined | DaemonSet Inherited from # KubeObjectStore.getByPath getChildPods # \u25b8 getChildPods ( daemonSet ): Pod [] Parameters # Name Type daemonSet DaemonSet Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): DaemonSet [] Returns # DaemonSet [] Inherited from # KubeObjectStore.getItems getStatuses # \u25b8 getStatuses ( daemonSets? ): Object Parameters # Name Type daemonSets? DaemonSet [] Returns # Object Name Type failed number pending number running number getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item DaemonSet Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? DaemonSet [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < DaemonSet > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | DaemonSet []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | DaemonSet []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < DaemonSet > Parameters # Name Type resourcePath string Returns # Promise < DaemonSet > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | DaemonSet > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < DaemonSet []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < DaemonSet []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): DaemonSet [] Parameters # Name Type partialItems DaemonSet [] \u00abdestructured\u00bb MergeItemsOptions Returns # DaemonSet [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < DaemonSet > Parameters # Name Type item DaemonSet patch Patch Returns # Promise < DaemonSet > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): DaemonSet [] Parameters # Name Type items DaemonSet [] Returns # DaemonSet [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | DaemonSet []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | DaemonSet []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item DaemonSet Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item DaemonSet request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items DaemonSet [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item DaemonSet Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # DaemonSet [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item DaemonSet Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? DaemonSet [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item DaemonSet Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < DaemonSet > Parameters # Name Type item DaemonSet data PartialObjectDeep < DaemonSet > Returns # Promise < DaemonSet > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < DaemonSet > Parameters # Name Type item DaemonSet request () => Promise < DaemonSet > Returns # Promise < DaemonSet > Inherited from # KubeObjectStore.updateItem","title":"Class: DaemonSetStore"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#class-daemonsetstore","text":"Renderer . K8sApi .DaemonSetStore","title":"Class: DaemonSetStore"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#hierarchy","text":"KubeObjectStore < DaemonSet , DaemonSetApi > \u21b3 DaemonSetStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#constructor","text":"\u2022 new DaemonSetStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#api","text":"\u2022 Readonly api : DaemonSetApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : DaemonSet ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#dependencies","text":"\u2022 Protected Readonly dependencies : DaemonSetStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , DaemonSetStatus , DaemonSetSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#items","text":"\u2022 items : IObservableArray < DaemonSet >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#iterator","text":"\u25b8 [iterator] (): Generator < DaemonSet , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#create","text":"\u25b8 create ( params , data? ): Promise < DaemonSet >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | DaemonSet >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): DaemonSet []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): DaemonSet []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbyid","text":"\u25b8 getById ( id ): undefined | DaemonSet","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): DaemonSet []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | DaemonSet","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | DaemonSet","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getchildpods","text":"\u25b8 getChildPods ( daemonSet ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getitems","text":"\u25b8 getItems (): DaemonSet []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getstatuses","text":"\u25b8 getStatuses ( daemonSets? ): Object","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#load","text":"\u25b8 load ( params ): Promise < DaemonSet >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | DaemonSet []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < DaemonSet >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | DaemonSet >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < DaemonSet []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): DaemonSet []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < DaemonSet >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): DaemonSet []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | DaemonSet []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#update","text":"\u25b8 update ( item , data ): Promise < DaemonSet >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < DaemonSet >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/","text":"Class: DeploymentStore # Renderer . K8sApi .DeploymentStore Hierarchy # KubeObjectStore < Deployment , DeploymentApi > \u21b3 DeploymentStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new DeploymentStore ( dependencies , api , opts? ) Parameters # Name Type dependencies DeploymentStoreDependencies api DeploymentApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : DeploymentApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Deployment ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Deployment Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : DeploymentStoreDependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Deployment > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Deployment , void , undefined > Returns # Generator < Deployment , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Deployment > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Deployment > Returns # Promise < Deployment > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Deployment > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Deployment > Returns # Promise < null | Deployment > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Deployment [] Parameters # Name Type items Deployment [] Returns # Deployment [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Deployment [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Deployment [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Deployment Parameters # Name Type id string Returns # undefined | Deployment Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Deployment [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Deployment [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Deployment Parameters # Name Type name string namespace? string Returns # undefined | Deployment Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Deployment Parameters # Name Type path string Returns # undefined | Deployment Inherited from # KubeObjectStore.getByPath getChildPods # \u25b8 getChildPods ( deployment ): Pod [] Parameters # Name Type deployment Deployment Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Deployment [] Returns # Deployment [] Inherited from # KubeObjectStore.getItems getStatuses # \u25b8 getStatuses ( deployments ): DeploymentStatuses Parameters # Name Type deployments Deployment [] Returns # DeploymentStatuses \u25b8 getStatuses ( deployments ): DeploymentStatuses Deprecated Parameters # Name Type deployments undefined | Deployment [] Returns # DeploymentStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Deployment Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Deployment [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Deployment > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Deployment > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Deployment []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Deployment []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Deployment > Parameters # Name Type resourcePath string Returns # Promise < Deployment > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Deployment > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Deployment > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Deployment []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Deployment []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Deployment [] Parameters # Name Type partialItems Deployment [] \u00abdestructured\u00bb MergeItemsOptions Returns # Deployment [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Deployment > Parameters # Name Type item Deployment patch Patch Returns # Promise < Deployment > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Deployment [] Parameters # Name Type items Deployment [] Returns # Deployment [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Deployment []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Deployment []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Deployment Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Deployment request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Deployment [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Deployment Returns # void Inherited from # KubeObjectStore.select sortItems # \u25b8 Protected sortItems ( items ): Deployment [] Parameters # Name Type items Deployment [] Returns # Deployment [] Overrides # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Deployment Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Deployment [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Deployment Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Deployment > Parameters # Name Type item Deployment data PartialObjectDeep < Deployment > Returns # Promise < Deployment > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Deployment > Parameters # Name Type item Deployment request () => Promise < Deployment > Returns # Promise < Deployment > Inherited from # KubeObjectStore.updateItem","title":"Class: DeploymentStore"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#class-deploymentstore","text":"Renderer . K8sApi .DeploymentStore","title":"Class: DeploymentStore"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#hierarchy","text":"KubeObjectStore < Deployment , DeploymentApi > \u21b3 DeploymentStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#constructor","text":"\u2022 new DeploymentStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#api","text":"\u2022 Readonly api : DeploymentApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Deployment ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#dependencies","text":"\u2022 Protected Readonly dependencies : DeploymentStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#items","text":"\u2022 items : IObservableArray < Deployment >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#iterator","text":"\u25b8 [iterator] (): Generator < Deployment , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#create","text":"\u25b8 create ( params , data? ): Promise < Deployment >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Deployment >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Deployment []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Deployment []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Deployment","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Deployment []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Deployment","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Deployment","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getchildpods","text":"\u25b8 getChildPods ( deployment ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getitems","text":"\u25b8 getItems (): Deployment []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getstatuses","text":"\u25b8 getStatuses ( deployments ): DeploymentStatuses","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#load","text":"\u25b8 load ( params ): Promise < Deployment >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Deployment []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Deployment >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Deployment >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Deployment []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Deployment []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Deployment >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Deployment []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Deployment []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#sortitems","text":"\u25b8 Protected sortItems ( items ): Deployment []","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#update","text":"\u25b8 update ( item , data ): Promise < Deployment >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Deployment >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/","text":"Class: EndpointStore # Renderer . K8sApi .EndpointStore Hierarchy # KubeObjectStore < Endpoint , EndpointsApi , EndpointsData > \u21b3 EndpointStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new EndpointStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api EndpointsApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : EndpointsApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Endpoint ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Endpoint Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < EndpointsData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Endpoint > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Endpoint , void , undefined > Returns # Generator < Endpoint , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Endpoint > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Endpoint > Returns # Promise < Endpoint > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Endpoint > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Endpoint > Returns # Promise < null | Endpoint > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Endpoint [] Parameters # Name Type items Endpoint [] Returns # Endpoint [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Endpoint [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Endpoint [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Endpoint Parameters # Name Type id string Returns # undefined | Endpoint Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Endpoint [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Endpoint [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Endpoint Parameters # Name Type name string namespace? string Returns # undefined | Endpoint Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Endpoint Parameters # Name Type path string Returns # undefined | Endpoint Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Endpoint [] Returns # Endpoint [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Endpoint Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Endpoint [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Endpoint > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Endpoint > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Endpoint []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Endpoint []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Endpoint > Parameters # Name Type resourcePath string Returns # Promise < Endpoint > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Endpoint > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Endpoint > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Endpoint []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Endpoint []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Endpoint [] Parameters # Name Type partialItems Endpoint [] \u00abdestructured\u00bb MergeItemsOptions Returns # Endpoint [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Endpoint > Parameters # Name Type item Endpoint patch Patch Returns # Promise < Endpoint > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Endpoint [] Parameters # Name Type items Endpoint [] Returns # Endpoint [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Endpoint []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Endpoint []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Endpoint Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Endpoint request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Endpoint [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Endpoint Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Endpoint [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Endpoint Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Endpoint [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Endpoint Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Endpoint > Parameters # Name Type item Endpoint data PartialObjectDeep < Endpoint > Returns # Promise < Endpoint > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Endpoint > Parameters # Name Type item Endpoint request () => Promise < Endpoint > Returns # Promise < Endpoint > Inherited from # KubeObjectStore.updateItem","title":"Class: EndpointStore"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#class-endpointstore","text":"Renderer . K8sApi .EndpointStore","title":"Class: EndpointStore"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#hierarchy","text":"KubeObjectStore < Endpoint , EndpointsApi , EndpointsData > \u21b3 EndpointStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#constructor","text":"\u2022 new EndpointStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#api","text":"\u2022 Readonly api : EndpointsApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Endpoint ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < EndpointsData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#items","text":"\u2022 items : IObservableArray < Endpoint >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#iterator","text":"\u25b8 [iterator] (): Generator < Endpoint , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#create","text":"\u25b8 create ( params , data? ): Promise < Endpoint >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Endpoint >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Endpoint []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Endpoint []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Endpoint","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Endpoint []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Endpoint","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Endpoint","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getitems","text":"\u25b8 getItems (): Endpoint []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#load","text":"\u25b8 load ( params ): Promise < Endpoint >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Endpoint []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Endpoint >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Endpoint >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Endpoint []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Endpoint []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Endpoint >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Endpoint []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Endpoint []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#update","text":"\u25b8 update ( item , data ): Promise < Endpoint >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Endpoint >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/","text":"Class: EventStore # Renderer . K8sApi .EventStore Hierarchy # KubeObjectStore < KubeEvent , KubeEventApi > \u21b3 EventStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getEventsByObject getIndexById getItems getTotalCount getWarnings getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new EventStore ( dependencies , api , opts? ) Parameters # Name Type dependencies EventStoreDependencies api KubeEventApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : KubeEventApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : KubeEvent ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item KubeEvent Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : EventStoreDependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeEventData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < KubeEvent > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < KubeEvent , void , undefined > Returns # Generator < KubeEvent , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater (): void Returns # void Overrides # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < KubeEvent > Returns # Promise < KubeEvent > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < KubeEvent > Returns # Promise < null | KubeEvent > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): KubeEvent [] Parameters # Name Type items KubeEvent [] Returns # KubeEvent [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): KubeEvent [] Parameters # Name Type namespace string | string [] strict? boolean Returns # KubeEvent [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | KubeEvent Parameters # Name Type id string Returns # undefined | KubeEvent Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): KubeEvent [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # KubeEvent [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | KubeEvent Parameters # Name Type name string namespace? string Returns # undefined | KubeEvent Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | KubeEvent Parameters # Name Type path string Returns # undefined | KubeEvent Inherited from # KubeObjectStore.getByPath getEventsByObject # \u25b8 getEventsByObject ( obj ): KubeEvent [] Parameters # Name Type obj KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # KubeEvent [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): KubeEvent [] Returns # KubeEvent [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount getWarnings # \u25b8 getWarnings (): KubeEvent [] Returns # KubeEvent [] getWarningsCount # \u25b8 getWarningsCount (): number Returns # number isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item KubeEvent Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? KubeEvent [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < KubeEvent > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | KubeEvent []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | KubeEvent []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < KubeEvent > Parameters # Name Type resourcePath string Returns # Promise < KubeEvent > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | KubeEvent > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < KubeEvent []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < KubeEvent []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): KubeEvent [] Parameters # Name Type partialItems KubeEvent [] \u00abdestructured\u00bb MergeItemsOptions Returns # KubeEvent [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < KubeEvent > Parameters # Name Type item KubeEvent patch Patch Returns # Promise < KubeEvent > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): KubeEvent [] Parameters # Name Type items KubeEvent [] Returns # KubeEvent [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | KubeEvent []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | KubeEvent []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item KubeEvent Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item KubeEvent request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items KubeEvent [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item KubeEvent Returns # void Inherited from # KubeObjectStore.select sortItems # \u25b8 Protected sortItems ( items ): KubeEvent [] Parameters # Name Type items KubeEvent [] Returns # KubeEvent [] Overrides # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item KubeEvent Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? KubeEvent [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item KubeEvent Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < KubeEvent > Parameters # Name Type item KubeEvent data PartialObjectDeep < KubeEvent > Returns # Promise < KubeEvent > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < KubeEvent > Parameters # Name Type item KubeEvent request () => Promise < KubeEvent > Returns # Promise < KubeEvent > Inherited from # KubeObjectStore.updateItem","title":"Class: EventStore"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#class-eventstore","text":"Renderer . K8sApi .EventStore","title":"Class: EventStore"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#hierarchy","text":"KubeObjectStore < KubeEvent , KubeEventApi > \u21b3 EventStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getEventsByObject getIndexById getItems getTotalCount getWarnings getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#constructor","text":"\u2022 new EventStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#api","text":"\u2022 Readonly api : KubeEventApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : KubeEvent ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#dependencies","text":"\u2022 Protected Readonly dependencies : EventStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeEventData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#items","text":"\u2022 items : IObservableArray < KubeEvent >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#iterator","text":"\u25b8 [iterator] (): Generator < KubeEvent , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater (): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#create","text":"\u25b8 create ( params , data? ): Promise < KubeEvent >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | KubeEvent >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): KubeEvent []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): KubeEvent []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbyid","text":"\u25b8 getById ( id ): undefined | KubeEvent","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): KubeEvent []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | KubeEvent","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | KubeEvent","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#geteventsbyobject","text":"\u25b8 getEventsByObject ( obj ): KubeEvent []","title":"getEventsByObject"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getitems","text":"\u25b8 getItems (): KubeEvent []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getwarnings","text":"\u25b8 getWarnings (): KubeEvent []","title":"getWarnings"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getwarningscount","text":"\u25b8 getWarningsCount (): number","title":"getWarningsCount"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#load","text":"\u25b8 load ( params ): Promise < KubeEvent >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | KubeEvent []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < KubeEvent >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | KubeEvent >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < KubeEvent []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): KubeEvent []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < KubeEvent >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): KubeEvent []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | KubeEvent []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#sortitems","text":"\u25b8 Protected sortItems ( items ): KubeEvent []","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#update","text":"\u25b8 update ( item , data ): Promise < KubeEvent >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < KubeEvent >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/","text":"Class: HPAStore # Renderer . K8sApi .HPAStore Hierarchy # KubeObjectStore < HorizontalPodAutoscaler , HorizontalPodAutoscalerApi > \u21b3 HPAStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new HPAStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api HorizontalPodAutoscalerApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : HorizontalPodAutoscalerApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : HorizontalPodAutoscaler ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item HorizontalPodAutoscaler Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , HorizontalPodAutoscalerStatus , HorizontalPodAutoscalerSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < HorizontalPodAutoscaler > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < HorizontalPodAutoscaler , void , undefined > Returns # Generator < HorizontalPodAutoscaler , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < HorizontalPodAutoscaler > Returns # Promise < null | HorizontalPodAutoscaler > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): HorizontalPodAutoscaler [] Parameters # Name Type items HorizontalPodAutoscaler [] Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): HorizontalPodAutoscaler [] Parameters # Name Type namespace string | string [] strict? boolean Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | HorizontalPodAutoscaler Parameters # Name Type id string Returns # undefined | HorizontalPodAutoscaler Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): HorizontalPodAutoscaler [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | HorizontalPodAutoscaler Parameters # Name Type name string namespace? string Returns # undefined | HorizontalPodAutoscaler Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | HorizontalPodAutoscaler Parameters # Name Type path string Returns # undefined | HorizontalPodAutoscaler Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): HorizontalPodAutoscaler [] Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item HorizontalPodAutoscaler Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? HorizontalPodAutoscaler [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | HorizontalPodAutoscaler []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | HorizontalPodAutoscaler []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < HorizontalPodAutoscaler > Parameters # Name Type resourcePath string Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | HorizontalPodAutoscaler > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < HorizontalPodAutoscaler []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < HorizontalPodAutoscaler []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): HorizontalPodAutoscaler [] Parameters # Name Type partialItems HorizontalPodAutoscaler [] \u00abdestructured\u00bb MergeItemsOptions Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < HorizontalPodAutoscaler > Parameters # Name Type item HorizontalPodAutoscaler patch Patch Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): HorizontalPodAutoscaler [] Parameters # Name Type items HorizontalPodAutoscaler [] Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | HorizontalPodAutoscaler []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | HorizontalPodAutoscaler []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item HorizontalPodAutoscaler Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item HorizontalPodAutoscaler request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items HorizontalPodAutoscaler [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item HorizontalPodAutoscaler Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item HorizontalPodAutoscaler Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? HorizontalPodAutoscaler [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item HorizontalPodAutoscaler Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < HorizontalPodAutoscaler > Parameters # Name Type item HorizontalPodAutoscaler data PartialObjectDeep < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < HorizontalPodAutoscaler > Parameters # Name Type item HorizontalPodAutoscaler request () => Promise < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore.updateItem","title":"Class: HPAStore"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#class-hpastore","text":"Renderer . K8sApi .HPAStore","title":"Class: HPAStore"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#hierarchy","text":"KubeObjectStore < HorizontalPodAutoscaler , HorizontalPodAutoscalerApi > \u21b3 HPAStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#constructor","text":"\u2022 new HPAStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#api","text":"\u2022 Readonly api : HorizontalPodAutoscalerApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : HorizontalPodAutoscaler ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , HorizontalPodAutoscalerStatus , HorizontalPodAutoscalerSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#items","text":"\u2022 items : IObservableArray < HorizontalPodAutoscaler >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#iterator","text":"\u25b8 [iterator] (): Generator < HorizontalPodAutoscaler , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#create","text":"\u25b8 create ( params , data? ): Promise < HorizontalPodAutoscaler >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | HorizontalPodAutoscaler >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): HorizontalPodAutoscaler []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): HorizontalPodAutoscaler []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbyid","text":"\u25b8 getById ( id ): undefined | HorizontalPodAutoscaler","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): HorizontalPodAutoscaler []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | HorizontalPodAutoscaler","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | HorizontalPodAutoscaler","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getitems","text":"\u25b8 getItems (): HorizontalPodAutoscaler []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#load","text":"\u25b8 load ( params ): Promise < HorizontalPodAutoscaler >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | HorizontalPodAutoscaler []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < HorizontalPodAutoscaler >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | HorizontalPodAutoscaler >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < HorizontalPodAutoscaler []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): HorizontalPodAutoscaler []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < HorizontalPodAutoscaler >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): HorizontalPodAutoscaler []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | HorizontalPodAutoscaler []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#update","text":"\u25b8 update ( item , data ): Promise < HorizontalPodAutoscaler >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < HorizontalPodAutoscaler >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/","text":"Class: IngressClassStore # Renderer . K8sApi .IngressClassStore Hierarchy # KubeObjectStore < IngressClass , IngressClassApi > \u21b3 IngressClassStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new IngressClassStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api IngressClassApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : IngressClassApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : IngressClass ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item IngressClass Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < IngressClassMetadata , IngressClassStatus , IngressClassSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < IngressClass > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < IngressClass , void , undefined > Returns # Generator < IngressClass , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < IngressClass > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < IngressClass > Returns # Promise < IngressClass > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | IngressClass > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < IngressClass > Returns # Promise < null | IngressClass > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): IngressClass [] Parameters # Name Type items IngressClass [] Returns # IngressClass [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): IngressClass [] Parameters # Name Type namespace string | string [] strict? boolean Returns # IngressClass [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | IngressClass Parameters # Name Type id string Returns # undefined | IngressClass Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): IngressClass [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # IngressClass [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | IngressClass Parameters # Name Type name string namespace? string Returns # undefined | IngressClass Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | IngressClass Parameters # Name Type path string Returns # undefined | IngressClass Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): IngressClass [] Returns # IngressClass [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item IngressClass Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? IngressClass [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < IngressClass > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < IngressClass > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | IngressClass []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | IngressClass []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < IngressClass > Parameters # Name Type resourcePath string Returns # Promise < IngressClass > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | IngressClass > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | IngressClass > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < IngressClass []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < IngressClass []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): IngressClass [] Parameters # Name Type partialItems IngressClass [] \u00abdestructured\u00bb MergeItemsOptions Returns # IngressClass [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < IngressClass > Parameters # Name Type item IngressClass patch Patch Returns # Promise < IngressClass > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): IngressClass [] Parameters # Name Type items IngressClass [] Returns # IngressClass [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | IngressClass []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | IngressClass []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item IngressClass Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item IngressClass request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items IngressClass [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item IngressClass Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # IngressClass [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item IngressClass Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? IngressClass [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item IngressClass Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < IngressClass > Parameters # Name Type item IngressClass data PartialObjectDeep < IngressClass > Returns # Promise < IngressClass > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < IngressClass > Parameters # Name Type item IngressClass request () => Promise < IngressClass > Returns # Promise < IngressClass > Inherited from # KubeObjectStore.updateItem","title":"Class: IngressClassStore"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#class-ingressclassstore","text":"Renderer . K8sApi .IngressClassStore","title":"Class: IngressClassStore"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#hierarchy","text":"KubeObjectStore < IngressClass , IngressClassApi > \u21b3 IngressClassStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#constructor","text":"\u2022 new IngressClassStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#api","text":"\u2022 Readonly api : IngressClassApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : IngressClass ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < IngressClassMetadata , IngressClassStatus , IngressClassSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#items","text":"\u2022 items : IObservableArray < IngressClass >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#iterator","text":"\u25b8 [iterator] (): Generator < IngressClass , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#create","text":"\u25b8 create ( params , data? ): Promise < IngressClass >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | IngressClass >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): IngressClass []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): IngressClass []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbyid","text":"\u25b8 getById ( id ): undefined | IngressClass","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): IngressClass []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | IngressClass","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | IngressClass","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getitems","text":"\u25b8 getItems (): IngressClass []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#load","text":"\u25b8 load ( params ): Promise < IngressClass >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | IngressClass []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < IngressClass >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | IngressClass >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < IngressClass []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): IngressClass []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < IngressClass >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): IngressClass []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | IngressClass []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#update","text":"\u25b8 update ( item , data ): Promise < IngressClass >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < IngressClass >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/","text":"Class: IngressStore # Renderer . K8sApi .IngressStore Hierarchy # KubeObjectStore < Ingress , IngressApi > \u21b3 IngressStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new IngressStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api IngressApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : IngressApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Ingress ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Ingress Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , IngressStatus , IngressSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Ingress > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Ingress , void , undefined > Returns # Generator < Ingress , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Ingress > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Ingress > Returns # Promise < Ingress > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Ingress > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Ingress > Returns # Promise < null | Ingress > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Ingress [] Parameters # Name Type items Ingress [] Returns # Ingress [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Ingress [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Ingress [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Ingress Parameters # Name Type id string Returns # undefined | Ingress Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Ingress [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Ingress [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Ingress Parameters # Name Type name string namespace? string Returns # undefined | Ingress Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Ingress Parameters # Name Type path string Returns # undefined | Ingress Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Ingress [] Returns # Ingress [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Ingress Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Ingress [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Ingress > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Ingress > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Ingress []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Ingress []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Ingress > Parameters # Name Type resourcePath string Returns # Promise < Ingress > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Ingress > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Ingress > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Ingress []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Ingress []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Ingress [] Parameters # Name Type partialItems Ingress [] \u00abdestructured\u00bb MergeItemsOptions Returns # Ingress [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Ingress > Parameters # Name Type item Ingress patch Patch Returns # Promise < Ingress > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Ingress [] Parameters # Name Type items Ingress [] Returns # Ingress [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Ingress []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Ingress []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Ingress Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Ingress request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Ingress [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Ingress Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Ingress [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Ingress Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Ingress [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Ingress Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Ingress > Parameters # Name Type item Ingress data PartialObjectDeep < Ingress > Returns # Promise < Ingress > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Ingress > Parameters # Name Type item Ingress request () => Promise < Ingress > Returns # Promise < Ingress > Inherited from # KubeObjectStore.updateItem","title":"Class: IngressStore"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#class-ingressstore","text":"Renderer . K8sApi .IngressStore","title":"Class: IngressStore"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#hierarchy","text":"KubeObjectStore < Ingress , IngressApi > \u21b3 IngressStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#constructor","text":"\u2022 new IngressStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#api","text":"\u2022 Readonly api : IngressApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Ingress ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , IngressStatus , IngressSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#items","text":"\u2022 items : IObservableArray < Ingress >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#iterator","text":"\u25b8 [iterator] (): Generator < Ingress , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#create","text":"\u25b8 create ( params , data? ): Promise < Ingress >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Ingress >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Ingress []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Ingress []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Ingress","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Ingress []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Ingress","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Ingress","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getitems","text":"\u25b8 getItems (): Ingress []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#load","text":"\u25b8 load ( params ): Promise < Ingress >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Ingress []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Ingress >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Ingress >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Ingress []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Ingress []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Ingress >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Ingress []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Ingress []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#update","text":"\u25b8 update ( item , data ): Promise < Ingress >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Ingress >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/","text":"Class: JobStore # Renderer . K8sApi .JobStore Hierarchy # KubeObjectStore < Job , JobApi > \u21b3 JobStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getJobsByOwner getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new JobStore ( dependencies , api , opts? ) Parameters # Name Type dependencies Dependencies api JobApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : JobApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Job ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Job Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : Dependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , JobStatus , JobSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Job > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Job , void , undefined > Returns # Generator < Job , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Job > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Job > Returns # Promise < Job > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Job > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Job > Returns # Promise < null | Job > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Job [] Parameters # Name Type items Job [] Returns # Job [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Job [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Job [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Job Parameters # Name Type id string Returns # undefined | Job Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Job [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Job [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Job Parameters # Name Type name string namespace? string Returns # undefined | Job Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Job Parameters # Name Type path string Returns # undefined | Job Inherited from # KubeObjectStore.getByPath getChildPods # \u25b8 getChildPods ( job ): Pod [] Parameters # Name Type job Job Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Job [] Returns # Job [] Inherited from # KubeObjectStore.getItems getJobsByOwner # \u25b8 getJobsByOwner ( cronJob ): Job [] Parameters # Name Type cronJob CronJob Returns # Job [] getStatuses # \u25b8 getStatuses ( jobs? ): Object Parameters # Name Type jobs? Job [] Returns # Object Name Type failed number pending number running number succeeded number getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Job Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Job [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Job > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Job > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Job []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Job []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Job > Parameters # Name Type resourcePath string Returns # Promise < Job > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Job > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Job > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Job []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Job []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Job [] Parameters # Name Type partialItems Job [] \u00abdestructured\u00bb MergeItemsOptions Returns # Job [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Job > Parameters # Name Type item Job patch Patch Returns # Promise < Job > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Job [] Parameters # Name Type items Job [] Returns # Job [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Job []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Job []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Job Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Job request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Job [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Job Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Job [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Job Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Job [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Job Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Job > Parameters # Name Type item Job data PartialObjectDeep < Job > Returns # Promise < Job > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Job > Parameters # Name Type item Job request () => Promise < Job > Returns # Promise < Job > Inherited from # KubeObjectStore.updateItem","title":"Class: JobStore"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#class-jobstore","text":"Renderer . K8sApi .JobStore","title":"Class: JobStore"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#hierarchy","text":"KubeObjectStore < Job , JobApi > \u21b3 JobStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getJobsByOwner getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#constructor","text":"\u2022 new JobStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#api","text":"\u2022 Readonly api : JobApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Job ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#dependencies","text":"\u2022 Protected Readonly dependencies : Dependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , JobStatus , JobSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#items","text":"\u2022 items : IObservableArray < Job >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#iterator","text":"\u25b8 [iterator] (): Generator < Job , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#create","text":"\u25b8 create ( params , data? ): Promise < Job >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Job >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Job []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Job []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Job","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Job []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Job","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Job","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getchildpods","text":"\u25b8 getChildPods ( job ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getitems","text":"\u25b8 getItems (): Job []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getjobsbyowner","text":"\u25b8 getJobsByOwner ( cronJob ): Job []","title":"getJobsByOwner"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getstatuses","text":"\u25b8 getStatuses ( jobs? ): Object","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#load","text":"\u25b8 load ( params ): Promise < Job >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Job []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Job >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Job >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Job []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Job []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Job >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Job []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Job []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#update","text":"\u25b8 update ( item , data ): Promise < Job >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Job >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/","text":"Class: KubeObjectStore # Renderer . K8sApi .KubeObjectStore Type parameters # Name Type K extends KubeObject = KubeObject A extends InternalKubeApi < K , D > = InternalKubeApi < K , KubeJsonApiDataFor < K >> D extends KubeJsonApiDataFor < K > = KubeApiDataFrom < K , A > Hierarchy # KubeObjectStore < K , A , D > \u21b3 KubeObjectStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds context Accessors # context contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new KubeObjectStore < K , A , D >( api , opts? ) Type parameters # Name Type 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 > Parameters # Name Type api A opts? KubeObjectStoreOptions Overrides # InternalKubeObjectStore.constructor \u2022 new KubeObjectStore < K , A , D >() Deprecated Supply API instance through constructor Type parameters # Name Type 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 > Overrides # InternalKubeObjectStore.constructor Properties # api # \u2022 Readonly api : A Inherited from # InternalKubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # InternalKubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : K ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item K Returns # string Inherited from # InternalKubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # InternalKubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < D >> Inherited from # InternalKubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # InternalKubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # InternalKubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # InternalKubeObjectStore.isLoading items # \u2022 items : IObservableArray < K > Inherited from # InternalKubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # InternalKubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # InternalKubeObjectStore.selectedItemsIds context # \u25aa Static Readonly context : Object Deprecated This is no longer used and shouldn't have been every really used Type declaration # Name Type get () => ClusterContext set ( ctx : ClusterContext ) => void Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # InternalKubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # InternalKubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # InternalKubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < K , void , undefined > Returns # Generator < K , void , undefined > Inherited from # InternalKubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # InternalKubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string data? PartialDeep < K > Returns # Promise < K > Inherited from # InternalKubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | K > Parameters # Name Type params Object params.name string params.namespace? string data? PartialDeep < K > Returns # Promise < null | K > Inherited from # InternalKubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): K [] Parameters # Name Type items K [] Returns # K [] Inherited from # InternalKubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): K [] Parameters # Name Type namespace string | string [] strict? boolean Returns # K [] Inherited from # InternalKubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | K Parameters # Name Type id string Returns # undefined | K Inherited from # InternalKubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): K [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # K [] Inherited from # InternalKubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | K Parameters # Name Type name string namespace? string Returns # undefined | K Inherited from # InternalKubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | K Parameters # Name Type path string Returns # undefined | K Inherited from # InternalKubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # InternalKubeObjectStore.getIndexById getItems # \u25b8 getItems (): K [] Returns # K [] Inherited from # InternalKubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # InternalKubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item K Returns # boolean Inherited from # InternalKubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? K [] Returns # boolean Inherited from # InternalKubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < K > Inherited from # InternalKubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | K []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | K []> Inherited from # InternalKubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < K > Parameters # Name Type resourcePath string Returns # Promise < K > Inherited from # InternalKubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | K > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | K > Inherited from # InternalKubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < K []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < K []> Inherited from # InternalKubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): K [] Parameters # Name Type partialItems K [] \u00abdestructured\u00bb MergeItemsOptions Returns # K [] Inherited from # InternalKubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < K > Parameters # Name Type item K patch Patch Returns # Promise < K > Inherited from # InternalKubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): K [] Parameters # Name Type items K [] Returns # K [] Inherited from # InternalKubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | K []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | K []> Inherited from # InternalKubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item K Returns # Promise < void > Inherited from # InternalKubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item K request () => Promise < any > Returns # Promise < void > Inherited from # InternalKubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items K [] Returns # Promise < void > Inherited from # InternalKubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # InternalKubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # InternalKubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # InternalKubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # InternalKubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item K Returns # void Inherited from # InternalKubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # K [] Inherited from # InternalKubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # InternalKubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item K Returns # void Inherited from # InternalKubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? K [] Returns # void Inherited from # InternalKubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item K Returns # void Inherited from # InternalKubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < K > Parameters # Name Type item K data PartialDeep < K > Returns # Promise < K > Inherited from # InternalKubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # InternalKubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < K > Parameters # Name Type item K request () => Promise < K > Returns # Promise < K > Inherited from # InternalKubeObjectStore.updateItem","title":"Class: KubeObjectStore"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#class-kubeobjectstorek-a-d","text":"Renderer . K8sApi .KubeObjectStore","title":"Class: KubeObjectStore<K, A, D>"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#type-parameters","text":"Name Type K extends KubeObject = KubeObject A extends InternalKubeApi < K , D > = InternalKubeApi < K , KubeJsonApiDataFor < K >> D extends KubeJsonApiDataFor < K > = KubeApiDataFrom < K , A >","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#hierarchy","text":"KubeObjectStore < K , A , D > \u21b3 KubeObjectStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds context","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#accessors","text":"context contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#constructor","text":"\u2022 new KubeObjectStore < K , A , D >( api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#api","text":"\u2022 Readonly api : A","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : K ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < D >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#items","text":"\u2022 items : IObservableArray < K >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#context","text":"\u25aa Static Readonly context : Object Deprecated This is no longer used and shouldn't have been every really used","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#context_1","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#iterator","text":"\u25b8 [iterator] (): Generator < K , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#create","text":"\u25b8 create ( params , data? ): Promise < K >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | K >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): K []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): K []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getbyid","text":"\u25b8 getById ( id ): undefined | K","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): K []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | K","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | K","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getitems","text":"\u25b8 getItems (): K []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#load","text":"\u25b8 load ( params ): Promise < K >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | K []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < K >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | K >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < K []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): K []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < K >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): K []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | K []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#update","text":"\u25b8 update ( item , data ): Promise < K >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < K >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/","text":"Class: LimitRangesStore # Renderer . K8sApi .LimitRangesStore Hierarchy # KubeObjectStore < LimitRange , LimitRangeApi > \u21b3 LimitRangesStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new LimitRangesStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api LimitRangeApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : LimitRangeApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : LimitRange ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item LimitRange Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , void , LimitRangeSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < LimitRange > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < LimitRange , void , undefined > Returns # Generator < LimitRange , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < LimitRange > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < LimitRange > Returns # Promise < LimitRange > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | LimitRange > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < LimitRange > Returns # Promise < null | LimitRange > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): LimitRange [] Parameters # Name Type items LimitRange [] Returns # LimitRange [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): LimitRange [] Parameters # Name Type namespace string | string [] strict? boolean Returns # LimitRange [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | LimitRange Parameters # Name Type id string Returns # undefined | LimitRange Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): LimitRange [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # LimitRange [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | LimitRange Parameters # Name Type name string namespace? string Returns # undefined | LimitRange Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | LimitRange Parameters # Name Type path string Returns # undefined | LimitRange Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): LimitRange [] Returns # LimitRange [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item LimitRange Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? LimitRange [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < LimitRange > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < LimitRange > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | LimitRange []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | LimitRange []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < LimitRange > Parameters # Name Type resourcePath string Returns # Promise < LimitRange > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | LimitRange > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | LimitRange > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < LimitRange []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < LimitRange []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): LimitRange [] Parameters # Name Type partialItems LimitRange [] \u00abdestructured\u00bb MergeItemsOptions Returns # LimitRange [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < LimitRange > Parameters # Name Type item LimitRange patch Patch Returns # Promise < LimitRange > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): LimitRange [] Parameters # Name Type items LimitRange [] Returns # LimitRange [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | LimitRange []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | LimitRange []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item LimitRange Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item LimitRange request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items LimitRange [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item LimitRange Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # LimitRange [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item LimitRange Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? LimitRange [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item LimitRange Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < LimitRange > Parameters # Name Type item LimitRange data PartialObjectDeep < LimitRange > Returns # Promise < LimitRange > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < LimitRange > Parameters # Name Type item LimitRange request () => Promise < LimitRange > Returns # Promise < LimitRange > Inherited from # KubeObjectStore.updateItem","title":"Class: LimitRangesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#class-limitrangesstore","text":"Renderer . K8sApi .LimitRangesStore","title":"Class: LimitRangesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#hierarchy","text":"KubeObjectStore < LimitRange , LimitRangeApi > \u21b3 LimitRangesStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#constructor","text":"\u2022 new LimitRangesStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#api","text":"\u2022 Readonly api : LimitRangeApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : LimitRange ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , void , LimitRangeSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#items","text":"\u2022 items : IObservableArray < LimitRange >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#iterator","text":"\u25b8 [iterator] (): Generator < LimitRange , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#create","text":"\u25b8 create ( params , data? ): Promise < LimitRange >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | LimitRange >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): LimitRange []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): LimitRange []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbyid","text":"\u25b8 getById ( id ): undefined | LimitRange","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): LimitRange []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | LimitRange","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | LimitRange","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getitems","text":"\u25b8 getItems (): LimitRange []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#load","text":"\u25b8 load ( params ): Promise < LimitRange >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | LimitRange []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < LimitRange >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | LimitRange >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < LimitRange []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): LimitRange []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < LimitRange >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): LimitRange []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | LimitRange []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#update","text":"\u25b8 update ( item , data ): Promise < LimitRange >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < LimitRange >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/","text":"Class: NamespaceStore # Renderer . K8sApi .NamespaceStore Hierarchy # KubeObjectStore < Namespace , NamespaceApi > \u21b3 NamespaceStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectNamespaces selectedItemsIds Accessors # allowedNamespaces areAllSelectedImplicitly contextItems contextNamespaces hasAllContexts query selectedItems selectedNames Methods # [iterator] bindWatchEventsUpdater clearSelected create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getNamespaceTree getTotalCount hasContext isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems onContextChange patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select selectAll selectSingle sortItems subscribe toggleAll toggleContext toggleSelection toggleSelectionAll toggleSingle unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new NamespaceStore ( dependencies , api ) Parameters # Name Type dependencies Dependencies api NamespaceApi Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : NamespaceApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Namespace ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Namespace Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : Dependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , NamespaceStatus , NamespaceSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Namespace > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectNamespaces # \u2022 selectNamespaces : ( namespace : string | string []) => void Type declaration # \u25b8 ( namespace ): void Parameters # Name Type namespace string | string [] Returns # void selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # allowedNamespaces # \u2022 get allowedNamespaces (): string [] Returns # string [] areAllSelectedImplicitly # \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 Returns # boolean contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems contextNamespaces # \u2022 get contextNamespaces (): string [] The list of selected namespace names (for filtering) Returns # string [] hasAllContexts # \u2022 get hasAllContexts (): boolean Is true if all available namespaces are selected, otherwise false Returns # boolean query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems selectedNames # \u2022 get selectedNames (): Set < string > The set of select namespace names (for filtering) Returns # Set < string > Methods # [iterator] # \u25b8 [iterator] (): Generator < Namespace , void , undefined > Returns # Generator < Namespace , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater clearSelected # \u25b8 clearSelected ( namespaces? ): void Parameters # Name Type namespaces? string | string [] Returns # void create # \u25b8 create ( params , data? ): Promise < Namespace > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Namespace > Returns # Promise < Namespace > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Namespace > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Namespace > Returns # Promise < null | Namespace > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Namespace [] Parameters # Name Type items Namespace [] Returns # Namespace [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Namespace [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Namespace [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Namespace Parameters # Name Type id string Returns # undefined | Namespace Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Namespace [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Namespace [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Namespace Parameters # Name Type name string namespace? string Returns # undefined | Namespace Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Namespace Parameters # Name Type path string Returns # undefined | Namespace Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Namespace [] Returns # Namespace [] Inherited from # KubeObjectStore.getItems getNamespaceTree # \u25b8 getNamespaceTree ( root ): NamespaceTree Parameters # Name Type root Namespace Returns # NamespaceTree getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount hasContext # \u25b8 hasContext ( namespaces ): boolean Checks if namespace names are selected for filtering Parameters # Name Type Description namespaces string | string [] One or several names of namespaces to check if they are selected Returns # boolean true if all the provided names are selected isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Namespace Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Namespace [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Namespace > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Namespace > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Namespace []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Namespace []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Namespace > Parameters # Name Type resourcePath string Returns # Promise < Namespace > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Namespace > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Namespace > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( params ): Promise < Namespace []> Parameters # Name Type params KubeObjectStoreLoadingParams Returns # Promise < Namespace []> Overrides # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Namespace [] Parameters # Name Type partialItems Namespace [] \u00abdestructured\u00bb MergeItemsOptions Returns # Namespace [] Inherited from # KubeObjectStore.mergeItems onContextChange # \u25b8 onContextChange ( callback , opts? ): IReactionDisposer Parameters # Name Type callback ( namespaces : string []) => void opts? Object opts.fireImmediately? boolean Returns # IReactionDisposer patch # \u25b8 patch ( item , patch ): Promise < Namespace > Parameters # Name Type item Namespace patch Patch Returns # Promise < Namespace > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Namespace [] Parameters # Name Type items Namespace [] Returns # Namespace [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Namespace []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Namespace []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Namespace Returns # Promise < void > Overrides # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Namespace request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Namespace [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Namespace Returns # void Inherited from # KubeObjectStore.select selectAll # \u25b8 selectAll (): void Selects all available namespaces. Note: If new namespaces appear in the future those will be selected too Returns # void selectSingle # \u25b8 selectSingle ( namespace ): void Makes the given namespace the sole selected namespace Parameters # Name Type namespace string Returns # void sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Namespace [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe (): (... args : T ) => void Returns # fn \u25b8 < T >( ...args ): void A function that does nothing Type parameters # Name Type T extends any [] Parameters # Name Type ...args T Returns # void Overrides # KubeObjectStore.subscribe toggleAll # \u25b8 toggleAll ( selectAll? ): void This function selects all namespaces implicitly. NOTE: does not toggle any namespaces Deprecated Use NamespaceStore.selectAll instead. Parameters # Name Type Description selectAll? boolean NOT USED Returns # void toggleContext # \u25b8 toggleContext ( namespaces ): void Acts like toggleSingle but can work on several at a time Parameters # Name Type Description namespaces string | string [] One or many names of namespaces to select Returns # void toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Namespace Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Namespace [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll toggleSingle # \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. Parameters # Name Type Description namespace string The name of a namespace Returns # void unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Namespace Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Namespace > Parameters # Name Type item Namespace data PartialObjectDeep < Namespace > Returns # Promise < Namespace > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Namespace > Parameters # Name Type item Namespace request () => Promise < Namespace > Returns # Promise < Namespace > Inherited from # KubeObjectStore.updateItem","title":"Class: NamespaceStore"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#class-namespacestore","text":"Renderer . K8sApi .NamespaceStore","title":"Class: NamespaceStore"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hierarchy","text":"KubeObjectStore < Namespace , NamespaceApi > \u21b3 NamespaceStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectNamespaces selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#accessors","text":"allowedNamespaces areAllSelectedImplicitly contextItems contextNamespaces hasAllContexts query selectedItems selectedNames","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#methods","text":"[iterator] bindWatchEventsUpdater clearSelected create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getNamespaceTree getTotalCount hasContext isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems onContextChange patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select selectAll selectSingle sortItems subscribe toggleAll toggleContext toggleSelection toggleSelectionAll toggleSingle unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#constructor","text":"\u2022 new NamespaceStore ( dependencies , api )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#api","text":"\u2022 Readonly api : NamespaceApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Namespace ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#dependencies","text":"\u2022 Protected Readonly dependencies : Dependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , NamespaceStatus , NamespaceSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#items","text":"\u2022 items : IObservableArray < Namespace >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectnamespaces","text":"\u2022 selectNamespaces : ( namespace : string | string []) => void","title":"selectNamespaces"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#allowednamespaces","text":"\u2022 get allowedNamespaces (): string []","title":"allowedNamespaces"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#areallselectedimplicitly","text":"\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","title":"areAllSelectedImplicitly"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#contextnamespaces","text":"\u2022 get contextNamespaces (): string [] The list of selected namespace names (for filtering)","title":"contextNamespaces"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hasallcontexts","text":"\u2022 get hasAllContexts (): boolean Is true if all available namespaces are selected, otherwise false","title":"hasAllContexts"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectednames","text":"\u2022 get selectedNames (): Set < string > The set of select namespace names (for filtering)","title":"selectedNames"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#iterator","text":"\u25b8 [iterator] (): Generator < Namespace , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#clearselected","text":"\u25b8 clearSelected ( namespaces? ): void","title":"clearSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#create","text":"\u25b8 create ( params , data? ): Promise < Namespace >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Namespace >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Namespace []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Namespace []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Namespace","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Namespace []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Namespace","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Namespace","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getitems","text":"\u25b8 getItems (): Namespace []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getnamespacetree","text":"\u25b8 getNamespaceTree ( root ): NamespaceTree","title":"getNamespaceTree"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hascontext","text":"\u25b8 hasContext ( namespaces ): boolean Checks if namespace names are selected for filtering","title":"hasContext"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#load","text":"\u25b8 load ( params ): Promise < Namespace >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Namespace []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Namespace >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Namespace >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loaditems","text":"\u25b8 Protected loadItems ( params ): Promise < Namespace []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Namespace []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#oncontextchange","text":"\u25b8 onContextChange ( callback , opts? ): IReactionDisposer","title":"onContextChange"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Namespace >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Namespace []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Namespace []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectall","text":"\u25b8 selectAll (): void Selects all available namespaces. Note: If new namespaces appear in the future those will be selected too","title":"selectAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectsingle","text":"\u25b8 selectSingle ( namespace ): void Makes the given namespace the sole selected namespace","title":"selectSingle"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#sortitems","text":"\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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#subscribe","text":"\u25b8 subscribe (): (... args : T ) => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleall","text":"\u25b8 toggleAll ( selectAll? ): void This function selects all namespaces implicitly. NOTE: does not toggle any namespaces Deprecated Use NamespaceStore.selectAll instead.","title":"toggleAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#togglecontext","text":"\u25b8 toggleContext ( namespaces ): void Acts like toggleSingle but can work on several at a time","title":"toggleContext"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#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.","title":"toggleSingle"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#update","text":"\u25b8 update ( item , data ): Promise < Namespace >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Namespace >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/","text":"Class: NetworkPolicyStore # Renderer . K8sApi .NetworkPolicyStore Hierarchy # KubeObjectStore < NetworkPolicy , NetworkPolicyApi > \u21b3 NetworkPolicyStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new NetworkPolicyStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api NetworkPolicyApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : NetworkPolicyApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : NetworkPolicy ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item NetworkPolicy Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , void , NetworkPolicySpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < NetworkPolicy > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < NetworkPolicy , void , undefined > Returns # Generator < NetworkPolicy , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < NetworkPolicy > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < NetworkPolicy > Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | NetworkPolicy > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < NetworkPolicy > Returns # Promise < null | NetworkPolicy > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): NetworkPolicy [] Parameters # Name Type items NetworkPolicy [] Returns # NetworkPolicy [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): NetworkPolicy [] Parameters # Name Type namespace string | string [] strict? boolean Returns # NetworkPolicy [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | NetworkPolicy Parameters # Name Type id string Returns # undefined | NetworkPolicy Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): NetworkPolicy [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # NetworkPolicy [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | NetworkPolicy Parameters # Name Type name string namespace? string Returns # undefined | NetworkPolicy Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | NetworkPolicy Parameters # Name Type path string Returns # undefined | NetworkPolicy Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): NetworkPolicy [] Returns # NetworkPolicy [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item NetworkPolicy Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? NetworkPolicy [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < NetworkPolicy > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | NetworkPolicy []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | NetworkPolicy []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < NetworkPolicy > Parameters # Name Type resourcePath string Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | NetworkPolicy > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | NetworkPolicy > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < NetworkPolicy []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < NetworkPolicy []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): NetworkPolicy [] Parameters # Name Type partialItems NetworkPolicy [] \u00abdestructured\u00bb MergeItemsOptions Returns # NetworkPolicy [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < NetworkPolicy > Parameters # Name Type item NetworkPolicy patch Patch Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): NetworkPolicy [] Parameters # Name Type items NetworkPolicy [] Returns # NetworkPolicy [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | NetworkPolicy []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | NetworkPolicy []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item NetworkPolicy Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item NetworkPolicy request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items NetworkPolicy [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item NetworkPolicy Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # NetworkPolicy [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item NetworkPolicy Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? NetworkPolicy [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item NetworkPolicy Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < NetworkPolicy > Parameters # Name Type item NetworkPolicy data PartialObjectDeep < NetworkPolicy > Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < NetworkPolicy > Parameters # Name Type item NetworkPolicy request () => Promise < NetworkPolicy > Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore.updateItem","title":"Class: NetworkPolicyStore"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#class-networkpolicystore","text":"Renderer . K8sApi .NetworkPolicyStore","title":"Class: NetworkPolicyStore"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#hierarchy","text":"KubeObjectStore < NetworkPolicy , NetworkPolicyApi > \u21b3 NetworkPolicyStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#constructor","text":"\u2022 new NetworkPolicyStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#api","text":"\u2022 Readonly api : NetworkPolicyApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : NetworkPolicy ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , void , NetworkPolicySpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#items","text":"\u2022 items : IObservableArray < NetworkPolicy >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#iterator","text":"\u25b8 [iterator] (): Generator < NetworkPolicy , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#create","text":"\u25b8 create ( params , data? ): Promise < NetworkPolicy >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | NetworkPolicy >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): NetworkPolicy []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): NetworkPolicy []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbyid","text":"\u25b8 getById ( id ): undefined | NetworkPolicy","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): NetworkPolicy []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | NetworkPolicy","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | NetworkPolicy","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getitems","text":"\u25b8 getItems (): NetworkPolicy []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#load","text":"\u25b8 load ( params ): Promise < NetworkPolicy >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | NetworkPolicy []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < NetworkPolicy >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | NetworkPolicy >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < NetworkPolicy []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): NetworkPolicy []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < NetworkPolicy >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): NetworkPolicy []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | NetworkPolicy []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#update","text":"\u25b8 update ( item , data ): Promise < NetworkPolicy >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < NetworkPolicy >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/","text":"Class: NodesStore # Renderer . K8sApi .NodesStore Hierarchy # KubeObjectStore < Node , NodeApi > \u21b3 NodesStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems masterNodes query selectedItems workerNodes Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new NodesStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api NodeApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : NodeApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Node ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Node Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , NodeStatus , NodeSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Node > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems masterNodes # \u2022 get masterNodes (): Node [] Returns # Node [] query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems workerNodes # \u2022 get workerNodes (): Node [] Returns # Node [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Node , void , undefined > Returns # Generator < Node , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Node > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Node > Returns # Promise < Node > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Node > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Node > Returns # Promise < null | Node > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Node [] Parameters # Name Type items Node [] Returns # Node [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Node [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Node [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Node Parameters # Name Type id string Returns # undefined | Node Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Node [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Node [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Node Parameters # Name Type name string namespace? string Returns # undefined | Node Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Node Parameters # Name Type path string Returns # undefined | Node Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Node [] Returns # Node [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount getWarningsCount # \u25b8 getWarningsCount (): number Returns # number isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Node Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Node [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Node > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Node > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Node []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Node []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Node > Parameters # Name Type resourcePath string Returns # Promise < Node > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Node > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Node > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Node []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Node []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Node [] Parameters # Name Type partialItems Node [] \u00abdestructured\u00bb MergeItemsOptions Returns # Node [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Node > Parameters # Name Type item Node patch Patch Returns # Promise < Node > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Node [] Parameters # Name Type items Node [] Returns # Node [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Node []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Node []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Node Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Node request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Node [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Node Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Node [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Node Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Node [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Node Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Node > Parameters # Name Type item Node data PartialObjectDeep < Node > Returns # Promise < Node > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Node > Parameters # Name Type item Node request () => Promise < Node > Returns # Promise < Node > Inherited from # KubeObjectStore.updateItem","title":"Class: NodesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#class-nodesstore","text":"Renderer . K8sApi .NodesStore","title":"Class: NodesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#hierarchy","text":"KubeObjectStore < Node , NodeApi > \u21b3 NodesStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#accessors","text":"contextItems masterNodes query selectedItems workerNodes","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#constructor","text":"\u2022 new NodesStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#api","text":"\u2022 Readonly api : NodeApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Node ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , NodeStatus , NodeSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#items","text":"\u2022 items : IObservableArray < Node >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#masternodes","text":"\u2022 get masterNodes (): Node []","title":"masterNodes"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#workernodes","text":"\u2022 get workerNodes (): Node []","title":"workerNodes"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#iterator","text":"\u25b8 [iterator] (): Generator < Node , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#create","text":"\u25b8 create ( params , data? ): Promise < Node >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Node >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Node []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Node []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Node","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Node []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Node","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Node","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getitems","text":"\u25b8 getItems (): Node []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getwarningscount","text":"\u25b8 getWarningsCount (): number","title":"getWarningsCount"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#load","text":"\u25b8 load ( params ): Promise < Node >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Node []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Node >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Node >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Node []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Node []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Node >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Node []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Node []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#update","text":"\u25b8 update ( item , data ): Promise < Node >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Node >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/","text":"Class: PersistentVolumesStore # Renderer . K8sApi .PersistentVolumesStore Hierarchy # KubeObjectStore < PersistentVolume , PersistentVolumeApi > \u21b3 PersistentVolumesStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getByStorageClass getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new PersistentVolumesStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api PersistentVolumeApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : PersistentVolumeApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : PersistentVolume ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item PersistentVolume Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , PersistentVolumeStatus , PersistentVolumeSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < PersistentVolume > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < PersistentVolume , void , undefined > Returns # Generator < PersistentVolume , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < PersistentVolume > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PersistentVolume > Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | PersistentVolume > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PersistentVolume > Returns # Promise < null | PersistentVolume > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): PersistentVolume [] Parameters # Name Type items PersistentVolume [] Returns # PersistentVolume [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): PersistentVolume [] Parameters # Name Type namespace string | string [] strict? boolean Returns # PersistentVolume [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | PersistentVolume Parameters # Name Type id string Returns # undefined | PersistentVolume Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): PersistentVolume [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # PersistentVolume [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | PersistentVolume Parameters # Name Type name string namespace? string Returns # undefined | PersistentVolume Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | PersistentVolume Parameters # Name Type path string Returns # undefined | PersistentVolume Inherited from # KubeObjectStore.getByPath getByStorageClass # \u25b8 getByStorageClass ( storageClass ): PersistentVolume [] Parameters # Name Type storageClass StorageClass Returns # PersistentVolume [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): PersistentVolume [] Returns # PersistentVolume [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item PersistentVolume Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? PersistentVolume [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < PersistentVolume > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PersistentVolume []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | PersistentVolume []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < PersistentVolume > Parameters # Name Type resourcePath string Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | PersistentVolume > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | PersistentVolume > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PersistentVolume []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < PersistentVolume []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PersistentVolume [] Parameters # Name Type partialItems PersistentVolume [] \u00abdestructured\u00bb MergeItemsOptions Returns # PersistentVolume [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < PersistentVolume > Parameters # Name Type item PersistentVolume patch Patch Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): PersistentVolume [] Parameters # Name Type items PersistentVolume [] Returns # PersistentVolume [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | PersistentVolume []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | PersistentVolume []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item PersistentVolume Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item PersistentVolume request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items PersistentVolume [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item PersistentVolume Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # PersistentVolume [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item PersistentVolume Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? PersistentVolume [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item PersistentVolume Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < PersistentVolume > Parameters # Name Type item PersistentVolume data PartialObjectDeep < PersistentVolume > Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < PersistentVolume > Parameters # Name Type item PersistentVolume request () => Promise < PersistentVolume > Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore.updateItem","title":"Class: PersistentVolumesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#class-persistentvolumesstore","text":"Renderer . K8sApi .PersistentVolumesStore","title":"Class: PersistentVolumesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#hierarchy","text":"KubeObjectStore < PersistentVolume , PersistentVolumeApi > \u21b3 PersistentVolumesStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getByStorageClass getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#constructor","text":"\u2022 new PersistentVolumesStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#api","text":"\u2022 Readonly api : PersistentVolumeApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : PersistentVolume ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , PersistentVolumeStatus , PersistentVolumeSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#items","text":"\u2022 items : IObservableArray < PersistentVolume >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#iterator","text":"\u25b8 [iterator] (): Generator < PersistentVolume , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#create","text":"\u25b8 create ( params , data? ): Promise < PersistentVolume >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | PersistentVolume >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): PersistentVolume []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): PersistentVolume []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbyid","text":"\u25b8 getById ( id ): undefined | PersistentVolume","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): PersistentVolume []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | PersistentVolume","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | PersistentVolume","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbystorageclass","text":"\u25b8 getByStorageClass ( storageClass ): PersistentVolume []","title":"getByStorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getitems","text":"\u25b8 getItems (): PersistentVolume []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#load","text":"\u25b8 load ( params ): Promise < PersistentVolume >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PersistentVolume []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < PersistentVolume >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | PersistentVolume >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PersistentVolume []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PersistentVolume []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < PersistentVolume >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): PersistentVolume []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | PersistentVolume []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#update","text":"\u25b8 update ( item , data ): Promise < PersistentVolume >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < PersistentVolume >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/","text":"Class: PodDisruptionBudgetsStore # Renderer . K8sApi .PodDisruptionBudgetsStore Hierarchy # KubeObjectStore < PodDisruptionBudget , PodDisruptionBudgetApi > \u21b3 PodDisruptionBudgetsStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new PodDisruptionBudgetsStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api PodDisruptionBudgetApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : PodDisruptionBudgetApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : PodDisruptionBudget ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item PodDisruptionBudget Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , V1Beta1PodDisruptionBudgetStatus | V1PodDisruptionBudgetStatus , PodDisruptionBudgetSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < PodDisruptionBudget > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < PodDisruptionBudget , void , undefined > Returns # Generator < PodDisruptionBudget , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < PodDisruptionBudget > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PodDisruptionBudget > Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | PodDisruptionBudget > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PodDisruptionBudget > Returns # Promise < null | PodDisruptionBudget > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): PodDisruptionBudget [] Parameters # Name Type items PodDisruptionBudget [] Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): PodDisruptionBudget [] Parameters # Name Type namespace string | string [] strict? boolean Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | PodDisruptionBudget Parameters # Name Type id string Returns # undefined | PodDisruptionBudget Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): PodDisruptionBudget [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | PodDisruptionBudget Parameters # Name Type name string namespace? string Returns # undefined | PodDisruptionBudget Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | PodDisruptionBudget Parameters # Name Type path string Returns # undefined | PodDisruptionBudget Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): PodDisruptionBudget [] Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item PodDisruptionBudget Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? PodDisruptionBudget [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < PodDisruptionBudget > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PodDisruptionBudget []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | PodDisruptionBudget []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < PodDisruptionBudget > Parameters # Name Type resourcePath string Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | PodDisruptionBudget > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | PodDisruptionBudget > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PodDisruptionBudget []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < PodDisruptionBudget []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PodDisruptionBudget [] Parameters # Name Type partialItems PodDisruptionBudget [] \u00abdestructured\u00bb MergeItemsOptions Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < PodDisruptionBudget > Parameters # Name Type item PodDisruptionBudget patch Patch Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): PodDisruptionBudget [] Parameters # Name Type items PodDisruptionBudget [] Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | PodDisruptionBudget []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | PodDisruptionBudget []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item PodDisruptionBudget Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item PodDisruptionBudget request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items PodDisruptionBudget [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item PodDisruptionBudget Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item PodDisruptionBudget Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? PodDisruptionBudget [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item PodDisruptionBudget Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < PodDisruptionBudget > Parameters # Name Type item PodDisruptionBudget data PartialObjectDeep < PodDisruptionBudget > Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < PodDisruptionBudget > Parameters # Name Type item PodDisruptionBudget request () => Promise < PodDisruptionBudget > Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore.updateItem","title":"Class: PodDisruptionBudgetsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#class-poddisruptionbudgetsstore","text":"Renderer . K8sApi .PodDisruptionBudgetsStore","title":"Class: PodDisruptionBudgetsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#hierarchy","text":"KubeObjectStore < PodDisruptionBudget , PodDisruptionBudgetApi > \u21b3 PodDisruptionBudgetsStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#constructor","text":"\u2022 new PodDisruptionBudgetsStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#api","text":"\u2022 Readonly api : PodDisruptionBudgetApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : PodDisruptionBudget ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , V1Beta1PodDisruptionBudgetStatus | V1PodDisruptionBudgetStatus , PodDisruptionBudgetSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#items","text":"\u2022 items : IObservableArray < PodDisruptionBudget >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#iterator","text":"\u25b8 [iterator] (): Generator < PodDisruptionBudget , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#create","text":"\u25b8 create ( params , data? ): Promise < PodDisruptionBudget >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | PodDisruptionBudget >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): PodDisruptionBudget []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): PodDisruptionBudget []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbyid","text":"\u25b8 getById ( id ): undefined | PodDisruptionBudget","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): PodDisruptionBudget []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | PodDisruptionBudget","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | PodDisruptionBudget","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getitems","text":"\u25b8 getItems (): PodDisruptionBudget []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#load","text":"\u25b8 load ( params ): Promise < PodDisruptionBudget >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PodDisruptionBudget []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < PodDisruptionBudget >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | PodDisruptionBudget >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PodDisruptionBudget []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PodDisruptionBudget []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < PodDisruptionBudget >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): PodDisruptionBudget []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | PodDisruptionBudget []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#update","text":"\u25b8 update ( item , data ): Promise < PodDisruptionBudget >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < PodDisruptionBudget >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/","text":"Class: PodsStore # Renderer . K8sApi .PodsStore Hierarchy # KubeObjectStore < Pod , PodApi > \u21b3 PodsStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items kubeMetrics limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getPodKubeMetrics getPodsByNode getPodsByOwner getPodsByOwnerId getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems loadKubeMetrics mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new PodsStore ( dependencies , api , opts? ) Parameters # Name Type dependencies PodStoreDependencies api PodApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : PodApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Pod ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Pod Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : PodStoreDependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , PodStatus , PodSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Pod > Inherited from # KubeObjectStore.items kubeMetrics # \u2022 Readonly kubeMetrics : IObservableArray < PodMetrics > limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Pod , void , undefined > Returns # Generator < Pod , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Pod > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Pod > Returns # Promise < Pod > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Pod > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Pod > Returns # Promise < null | Pod > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Pod [] Parameters # Name Type items Pod [] Returns # Pod [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Pod [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Pod [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Pod Parameters # Name Type id string Returns # undefined | Pod Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Pod [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Pod [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Pod Parameters # Name Type name string namespace? string Returns # undefined | Pod Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Pod Parameters # Name Type path string Returns # undefined | Pod Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Pod [] Returns # Pod [] Inherited from # KubeObjectStore.getItems getPodKubeMetrics # \u25b8 getPodKubeMetrics ( pod ): Object Parameters # Name Type pod Pod Returns # Object Name Type cpu number memory number getPodsByNode # \u25b8 getPodsByNode ( node ): Pod [] Parameters # Name Type node string Returns # Pod [] getPodsByOwner # \u25b8 getPodsByOwner ( workload ): Pod [] Parameters # Name Type workload KubeObject < NamespaceScopedMetadata , unknown , unknown > Returns # Pod [] getPodsByOwnerId # \u25b8 getPodsByOwnerId ( workloadId ): Pod [] Parameters # Name Type workloadId string Returns # Pod [] getStatuses # \u25b8 getStatuses ( pods ): Dictionary < number > Parameters # Name Type pods Pod [] Returns # Dictionary < number > getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Pod Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Pod [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Pod > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Pod > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Pod []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Pod []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Pod > Parameters # Name Type resourcePath string Returns # Promise < Pod > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Pod > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Pod > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Pod []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Pod []> Inherited from # KubeObjectStore.loadItems loadKubeMetrics # \u25b8 loadKubeMetrics ( namespace? ): Promise < void > Parameters # Name Type namespace? string Returns # Promise < void > mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Pod [] Parameters # Name Type partialItems Pod [] \u00abdestructured\u00bb MergeItemsOptions Returns # Pod [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Pod > Parameters # Name Type item Pod patch Patch Returns # Promise < Pod > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Pod [] Parameters # Name Type items Pod [] Returns # Pod [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Pod []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Pod []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Pod Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Pod request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Pod [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Pod Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Pod [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Pod Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Pod [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Pod Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Pod > Parameters # Name Type item Pod data PartialObjectDeep < Pod > Returns # Promise < Pod > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Pod > Parameters # Name Type item Pod request () => Promise < Pod > Returns # Promise < Pod > Inherited from # KubeObjectStore.updateItem","title":"Class: PodsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#class-podsstore","text":"Renderer . K8sApi .PodsStore","title":"Class: PodsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#hierarchy","text":"KubeObjectStore < Pod , PodApi > \u21b3 PodsStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items kubeMetrics limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getPodKubeMetrics getPodsByNode getPodsByOwner getPodsByOwnerId getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems loadKubeMetrics mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#constructor","text":"\u2022 new PodsStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#api","text":"\u2022 Readonly api : PodApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Pod ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#dependencies","text":"\u2022 Protected Readonly dependencies : PodStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , PodStatus , PodSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#items","text":"\u2022 items : IObservableArray < Pod >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#kubemetrics","text":"\u2022 Readonly kubeMetrics : IObservableArray < PodMetrics >","title":"kubeMetrics"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#iterator","text":"\u25b8 [iterator] (): Generator < Pod , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#create","text":"\u25b8 create ( params , data? ): Promise < Pod >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Pod >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Pod []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Pod []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Pod","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Pod []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Pod","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Pod","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getitems","text":"\u25b8 getItems (): Pod []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodkubemetrics","text":"\u25b8 getPodKubeMetrics ( pod ): Object","title":"getPodKubeMetrics"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodsbynode","text":"\u25b8 getPodsByNode ( node ): Pod []","title":"getPodsByNode"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodsbyowner","text":"\u25b8 getPodsByOwner ( workload ): Pod []","title":"getPodsByOwner"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodsbyownerid","text":"\u25b8 getPodsByOwnerId ( workloadId ): Pod []","title":"getPodsByOwnerId"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getstatuses","text":"\u25b8 getStatuses ( pods ): Dictionary < number >","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#load","text":"\u25b8 load ( params ): Promise < Pod >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Pod []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Pod >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Pod >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Pod []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loadkubemetrics","text":"\u25b8 loadKubeMetrics ( namespace? ): Promise < void >","title":"loadKubeMetrics"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Pod []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Pod >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Pod []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Pod []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#update","text":"\u25b8 update ( item , data ): Promise < Pod >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Pod >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/","text":"Class: PriorityClassStoreStore # Renderer . K8sApi .PriorityClassStoreStore Hierarchy # KubeObjectStore < PriorityClass , PriorityClassApi > \u21b3 PriorityClassStoreStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new PriorityClassStoreStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api PriorityClassApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : PriorityClassApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : PriorityClass ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item PriorityClass Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < PriorityClassData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < PriorityClass > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < PriorityClass , void , undefined > Returns # Generator < PriorityClass , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < PriorityClass > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PriorityClass > Returns # Promise < PriorityClass > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | PriorityClass > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PriorityClass > Returns # Promise < null | PriorityClass > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): PriorityClass [] Parameters # Name Type items PriorityClass [] Returns # PriorityClass [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): PriorityClass [] Parameters # Name Type namespace string | string [] strict? boolean Returns # PriorityClass [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | PriorityClass Parameters # Name Type id string Returns # undefined | PriorityClass Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): PriorityClass [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # PriorityClass [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | PriorityClass Parameters # Name Type name string namespace? string Returns # undefined | PriorityClass Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | PriorityClass Parameters # Name Type path string Returns # undefined | PriorityClass Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): PriorityClass [] Returns # PriorityClass [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item PriorityClass Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? PriorityClass [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < PriorityClass > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < PriorityClass > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PriorityClass []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | PriorityClass []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < PriorityClass > Parameters # Name Type resourcePath string Returns # Promise < PriorityClass > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | PriorityClass > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | PriorityClass > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PriorityClass []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < PriorityClass []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PriorityClass [] Parameters # Name Type partialItems PriorityClass [] \u00abdestructured\u00bb MergeItemsOptions Returns # PriorityClass [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < PriorityClass > Parameters # Name Type item PriorityClass patch Patch Returns # Promise < PriorityClass > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): PriorityClass [] Parameters # Name Type items PriorityClass [] Returns # PriorityClass [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | PriorityClass []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | PriorityClass []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item PriorityClass Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item PriorityClass request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items PriorityClass [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item PriorityClass Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # PriorityClass [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item PriorityClass Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? PriorityClass [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item PriorityClass Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < PriorityClass > Parameters # Name Type item PriorityClass data PartialObjectDeep < PriorityClass > Returns # Promise < PriorityClass > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < PriorityClass > Parameters # Name Type item PriorityClass request () => Promise < PriorityClass > Returns # Promise < PriorityClass > Inherited from # KubeObjectStore.updateItem","title":"Class: PriorityClassStoreStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#class-priorityclassstorestore","text":"Renderer . K8sApi .PriorityClassStoreStore","title":"Class: PriorityClassStoreStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#hierarchy","text":"KubeObjectStore < PriorityClass , PriorityClassApi > \u21b3 PriorityClassStoreStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#constructor","text":"\u2022 new PriorityClassStoreStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#api","text":"\u2022 Readonly api : PriorityClassApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : PriorityClass ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < PriorityClassData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#items","text":"\u2022 items : IObservableArray < PriorityClass >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#iterator","text":"\u25b8 [iterator] (): Generator < PriorityClass , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#create","text":"\u25b8 create ( params , data? ): Promise < PriorityClass >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | PriorityClass >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): PriorityClass []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): PriorityClass []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbyid","text":"\u25b8 getById ( id ): undefined | PriorityClass","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): PriorityClass []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | PriorityClass","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | PriorityClass","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getitems","text":"\u25b8 getItems (): PriorityClass []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#load","text":"\u25b8 load ( params ): Promise < PriorityClass >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PriorityClass []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < PriorityClass >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | PriorityClass >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PriorityClass []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PriorityClass []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < PriorityClass >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): PriorityClass []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | PriorityClass []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#update","text":"\u25b8 update ( item , data ): Promise < PriorityClass >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < PriorityClass >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/","text":"Class: ReplicaSetStore # Renderer . K8sApi .ReplicaSetStore Hierarchy # KubeObjectStore < ReplicaSet , ReplicaSetApi > \u21b3 ReplicaSetStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getReplicaSetsByOwner getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ReplicaSetStore ( dependencies , api , opts? ) Parameters # Name Type dependencies ReplicaSetStoreDependencies api ReplicaSetApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : ReplicaSetApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : ReplicaSet ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item ReplicaSet Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : ReplicaSetStoreDependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , ReplicaSetStatus , ReplicaSetSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < ReplicaSet > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < ReplicaSet , void , undefined > Returns # Generator < ReplicaSet , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < ReplicaSet > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < ReplicaSet > Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | ReplicaSet > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < ReplicaSet > Returns # Promise < null | ReplicaSet > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): ReplicaSet [] Parameters # Name Type items ReplicaSet [] Returns # ReplicaSet [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): ReplicaSet [] Parameters # Name Type namespace string | string [] strict? boolean Returns # ReplicaSet [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | ReplicaSet Parameters # Name Type id string Returns # undefined | ReplicaSet Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): ReplicaSet [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # ReplicaSet [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | ReplicaSet Parameters # Name Type name string namespace? string Returns # undefined | ReplicaSet Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | ReplicaSet Parameters # Name Type path string Returns # undefined | ReplicaSet Inherited from # KubeObjectStore.getByPath getChildPods # \u25b8 getChildPods ( replicaSet ): Pod [] Parameters # Name Type replicaSet ReplicaSet Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): ReplicaSet [] Returns # ReplicaSet [] Inherited from # KubeObjectStore.getItems getReplicaSetsByOwner # \u25b8 getReplicaSetsByOwner ( deployment ): ReplicaSet [] Parameters # Name Type deployment Deployment Returns # ReplicaSet [] getStatuses # \u25b8 getStatuses ( replicaSets ): Object Parameters # Name Type replicaSets ReplicaSet [] Returns # Object Name Type failed number pending number running number getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item ReplicaSet Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? ReplicaSet [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < ReplicaSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ReplicaSet []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | ReplicaSet []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < ReplicaSet > Parameters # Name Type resourcePath string Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | ReplicaSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | ReplicaSet > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ReplicaSet []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < ReplicaSet []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ReplicaSet [] Parameters # Name Type partialItems ReplicaSet [] \u00abdestructured\u00bb MergeItemsOptions Returns # ReplicaSet [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < ReplicaSet > Parameters # Name Type item ReplicaSet patch Patch Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): ReplicaSet [] Parameters # Name Type items ReplicaSet [] Returns # ReplicaSet [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | ReplicaSet []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | ReplicaSet []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item ReplicaSet Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item ReplicaSet request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items ReplicaSet [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item ReplicaSet Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # ReplicaSet [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item ReplicaSet Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? ReplicaSet [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item ReplicaSet Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < ReplicaSet > Parameters # Name Type item ReplicaSet data PartialObjectDeep < ReplicaSet > Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < ReplicaSet > Parameters # Name Type item ReplicaSet request () => Promise < ReplicaSet > Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore.updateItem","title":"Class: ReplicaSetStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#class-replicasetstore","text":"Renderer . K8sApi .ReplicaSetStore","title":"Class: ReplicaSetStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#hierarchy","text":"KubeObjectStore < ReplicaSet , ReplicaSetApi > \u21b3 ReplicaSetStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getReplicaSetsByOwner getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#constructor","text":"\u2022 new ReplicaSetStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#api","text":"\u2022 Readonly api : ReplicaSetApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : ReplicaSet ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#dependencies","text":"\u2022 Protected Readonly dependencies : ReplicaSetStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , ReplicaSetStatus , ReplicaSetSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#items","text":"\u2022 items : IObservableArray < ReplicaSet >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#iterator","text":"\u25b8 [iterator] (): Generator < ReplicaSet , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#create","text":"\u25b8 create ( params , data? ): Promise < ReplicaSet >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | ReplicaSet >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): ReplicaSet []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): ReplicaSet []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbyid","text":"\u25b8 getById ( id ): undefined | ReplicaSet","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): ReplicaSet []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | ReplicaSet","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | ReplicaSet","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getchildpods","text":"\u25b8 getChildPods ( replicaSet ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getitems","text":"\u25b8 getItems (): ReplicaSet []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getreplicasetsbyowner","text":"\u25b8 getReplicaSetsByOwner ( deployment ): ReplicaSet []","title":"getReplicaSetsByOwner"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getstatuses","text":"\u25b8 getStatuses ( replicaSets ): Object","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#load","text":"\u25b8 load ( params ): Promise < ReplicaSet >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ReplicaSet []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < ReplicaSet >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | ReplicaSet >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ReplicaSet []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ReplicaSet []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < ReplicaSet >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): ReplicaSet []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | ReplicaSet []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#update","text":"\u25b8 update ( item , data ): Promise < ReplicaSet >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < ReplicaSet >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/","text":"Class: ResourceQuotasStore # Renderer . K8sApi .ResourceQuotasStore Hierarchy # KubeObjectStore < ResourceQuota , ResourceQuotaApi > \u21b3 ResourceQuotasStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ResourceQuotasStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api ResourceQuotaApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : ResourceQuotaApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : ResourceQuota ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item ResourceQuota Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , ResourceQuotaStatus , ResourceQuotaSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < ResourceQuota > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < ResourceQuota , void , undefined > Returns # Generator < ResourceQuota , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < ResourceQuota > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < ResourceQuota > Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | ResourceQuota > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < ResourceQuota > Returns # Promise < null | ResourceQuota > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): ResourceQuota [] Parameters # Name Type items ResourceQuota [] Returns # ResourceQuota [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): ResourceQuota [] Parameters # Name Type namespace string | string [] strict? boolean Returns # ResourceQuota [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | ResourceQuota Parameters # Name Type id string Returns # undefined | ResourceQuota Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): ResourceQuota [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # ResourceQuota [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | ResourceQuota Parameters # Name Type name string namespace? string Returns # undefined | ResourceQuota Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | ResourceQuota Parameters # Name Type path string Returns # undefined | ResourceQuota Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): ResourceQuota [] Returns # ResourceQuota [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item ResourceQuota Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? ResourceQuota [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < ResourceQuota > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ResourceQuota []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | ResourceQuota []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < ResourceQuota > Parameters # Name Type resourcePath string Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | ResourceQuota > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | ResourceQuota > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ResourceQuota []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < ResourceQuota []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ResourceQuota [] Parameters # Name Type partialItems ResourceQuota [] \u00abdestructured\u00bb MergeItemsOptions Returns # ResourceQuota [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < ResourceQuota > Parameters # Name Type item ResourceQuota patch Patch Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): ResourceQuota [] Parameters # Name Type items ResourceQuota [] Returns # ResourceQuota [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | ResourceQuota []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | ResourceQuota []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item ResourceQuota Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item ResourceQuota request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items ResourceQuota [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item ResourceQuota Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # ResourceQuota [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item ResourceQuota Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? ResourceQuota [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item ResourceQuota Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < ResourceQuota > Parameters # Name Type item ResourceQuota data PartialObjectDeep < ResourceQuota > Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < ResourceQuota > Parameters # Name Type item ResourceQuota request () => Promise < ResourceQuota > Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore.updateItem","title":"Class: ResourceQuotasStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#class-resourcequotasstore","text":"Renderer . K8sApi .ResourceQuotasStore","title":"Class: ResourceQuotasStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#hierarchy","text":"KubeObjectStore < ResourceQuota , ResourceQuotaApi > \u21b3 ResourceQuotasStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#constructor","text":"\u2022 new ResourceQuotasStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#api","text":"\u2022 Readonly api : ResourceQuotaApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : ResourceQuota ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , ResourceQuotaStatus , ResourceQuotaSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#items","text":"\u2022 items : IObservableArray < ResourceQuota >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#iterator","text":"\u25b8 [iterator] (): Generator < ResourceQuota , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#create","text":"\u25b8 create ( params , data? ): Promise < ResourceQuota >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | ResourceQuota >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): ResourceQuota []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): ResourceQuota []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbyid","text":"\u25b8 getById ( id ): undefined | ResourceQuota","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): ResourceQuota []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | ResourceQuota","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | ResourceQuota","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getitems","text":"\u25b8 getItems (): ResourceQuota []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#load","text":"\u25b8 load ( params ): Promise < ResourceQuota >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ResourceQuota []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < ResourceQuota >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | ResourceQuota >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ResourceQuota []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ResourceQuota []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < ResourceQuota >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): ResourceQuota []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | ResourceQuota []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#update","text":"\u25b8 update ( item , data ): Promise < ResourceQuota >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < ResourceQuota >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/","text":"Class: ResourceStack # Renderer . K8sApi .ResourceStack Deprecated Switch to using Common.createResourceStack instead Implements # ResourceApplyingStack Table of contents # Constructors # constructor Methods # kubectlApplyFolder kubectlDeleteFolder Constructors # constructor # \u2022 new ResourceStack ( cluster , name ) Parameters # Name Type cluster KubernetesCluster < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > name string Methods # kubectlApplyFolder # \u25b8 kubectlApplyFolder ( folderPath , templateContext? , extraArgs? ): Promise < string > Parameters # Name Type folderPath string templateContext? any extraArgs? string [] Returns # Promise < string > Implementation of # ResourceApplyingStack.kubectlApplyFolder kubectlDeleteFolder # \u25b8 kubectlDeleteFolder ( folderPath , templateContext? , extraArgs? ): Promise < string > Parameters # Name Type folderPath string templateContext? any extraArgs? string [] Returns # Promise < string > Implementation of # ResourceApplyingStack.kubectlDeleteFolder","title":"Class: ResourceStack"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#class-resourcestack","text":"Renderer . K8sApi .ResourceStack Deprecated Switch to using Common.createResourceStack instead","title":"Class: ResourceStack"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#implements","text":"ResourceApplyingStack","title":"Implements"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#methods","text":"kubectlApplyFolder kubectlDeleteFolder","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#constructor","text":"\u2022 new ResourceStack ( cluster , name )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#kubectlapplyfolder","text":"\u25b8 kubectlApplyFolder ( folderPath , templateContext? , extraArgs? ): Promise < string >","title":"kubectlApplyFolder"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#kubectldeletefolder","text":"\u25b8 kubectlDeleteFolder ( folderPath , templateContext? , extraArgs? ): Promise < string >","title":"kubectlDeleteFolder"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/","text":"Class: RoleBindingsStore # Renderer . K8sApi .RoleBindingsStore Hierarchy # KubeObjectStore < RoleBinding , RoleBindingApi , RoleBindingData > \u21b3 RoleBindingsStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems removeSubjects reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem updateSubjects Constructors # constructor # \u2022 new RoleBindingsStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api RoleBindingApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : RoleBindingApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : RoleBinding ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item RoleBinding Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < RoleBindingData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < RoleBinding > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < RoleBinding , void , undefined > Returns # Generator < RoleBinding , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < RoleBinding > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < RoleBinding > Returns # Promise < RoleBinding > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | RoleBinding > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < RoleBinding > Returns # Promise < null | RoleBinding > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): RoleBinding [] Parameters # Name Type items RoleBinding [] Returns # RoleBinding [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): RoleBinding [] Parameters # Name Type namespace string | string [] strict? boolean Returns # RoleBinding [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | RoleBinding Parameters # Name Type id string Returns # undefined | RoleBinding Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): RoleBinding [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # RoleBinding [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | RoleBinding Parameters # Name Type name string namespace? string Returns # undefined | RoleBinding Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | RoleBinding Parameters # Name Type path string Returns # undefined | RoleBinding Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): RoleBinding [] Returns # RoleBinding [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item RoleBinding Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? RoleBinding [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < RoleBinding > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < RoleBinding > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | RoleBinding []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | RoleBinding []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < RoleBinding > Parameters # Name Type resourcePath string Returns # Promise < RoleBinding > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | RoleBinding > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | RoleBinding > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < RoleBinding []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < RoleBinding []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): RoleBinding [] Parameters # Name Type partialItems RoleBinding [] \u00abdestructured\u00bb MergeItemsOptions Returns # RoleBinding [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < RoleBinding > Parameters # Name Type item RoleBinding patch Patch Returns # Promise < RoleBinding > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): RoleBinding [] Parameters # Name Type items RoleBinding [] Returns # RoleBinding [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | RoleBinding []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | RoleBinding []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item RoleBinding Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item RoleBinding request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items RoleBinding [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems removeSubjects # \u25b8 removeSubjects ( roleBinding , subjectsToRemove ): Promise < RoleBinding > Parameters # Name Type roleBinding RoleBinding subjectsToRemove Iterable < Subject > Returns # Promise < RoleBinding > reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item RoleBinding Returns # void Inherited from # KubeObjectStore.select sortItems # \u25b8 Protected sortItems ( items ): RoleBinding [] Parameters # Name Type items RoleBinding [] Returns # RoleBinding [] Overrides # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item RoleBinding Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? RoleBinding [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item RoleBinding Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < RoleBinding > Parameters # Name Type item RoleBinding data PartialObjectDeep < RoleBinding > Returns # Promise < RoleBinding > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < RoleBinding > Parameters # Name Type item RoleBinding request () => Promise < RoleBinding > Returns # Promise < RoleBinding > Inherited from # KubeObjectStore.updateItem updateSubjects # \u25b8 updateSubjects ( roleBinding , subjects ): Promise < RoleBinding > Parameters # Name Type roleBinding RoleBinding subjects Subject [] Returns # Promise < RoleBinding >","title":"Class: RoleBindingsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#class-rolebindingsstore","text":"Renderer . K8sApi .RoleBindingsStore","title":"Class: RoleBindingsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#hierarchy","text":"KubeObjectStore < RoleBinding , RoleBindingApi , RoleBindingData > \u21b3 RoleBindingsStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems removeSubjects reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem updateSubjects","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#constructor","text":"\u2022 new RoleBindingsStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#api","text":"\u2022 Readonly api : RoleBindingApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : RoleBinding ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < RoleBindingData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#items","text":"\u2022 items : IObservableArray < RoleBinding >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#iterator","text":"\u25b8 [iterator] (): Generator < RoleBinding , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#create","text":"\u25b8 create ( params , data? ): Promise < RoleBinding >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | RoleBinding >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): RoleBinding []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): RoleBinding []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbyid","text":"\u25b8 getById ( id ): undefined | RoleBinding","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): RoleBinding []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | RoleBinding","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | RoleBinding","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getitems","text":"\u25b8 getItems (): RoleBinding []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#load","text":"\u25b8 load ( params ): Promise < RoleBinding >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | RoleBinding []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < RoleBinding >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | RoleBinding >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < RoleBinding []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): RoleBinding []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < RoleBinding >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): RoleBinding []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | RoleBinding []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removesubjects","text":"\u25b8 removeSubjects ( roleBinding , subjectsToRemove ): Promise < RoleBinding >","title":"removeSubjects"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#sortitems","text":"\u25b8 Protected sortItems ( items ): RoleBinding []","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#update","text":"\u25b8 update ( item , data ): Promise < RoleBinding >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < RoleBinding >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#updatesubjects","text":"\u25b8 updateSubjects ( roleBinding , subjects ): Promise < RoleBinding >","title":"updateSubjects"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/","text":"Class: RolesStore # Renderer . K8sApi .RolesStore Hierarchy # KubeObjectStore < Role , RoleApi , RoleData > \u21b3 RolesStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new RolesStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api RoleApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : RoleApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Role ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Role Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < RoleData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Role > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Role , void , undefined > Returns # Generator < Role , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Role > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Role > Returns # Promise < Role > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Role > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Role > Returns # Promise < null | Role > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Role [] Parameters # Name Type items Role [] Returns # Role [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Role [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Role [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Role Parameters # Name Type id string Returns # undefined | Role Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Role [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Role [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Role Parameters # Name Type name string namespace? string Returns # undefined | Role Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Role Parameters # Name Type path string Returns # undefined | Role Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Role [] Returns # Role [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Role Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Role [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Role > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Role > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Role []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Role []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Role > Parameters # Name Type resourcePath string Returns # Promise < Role > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Role > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Role > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Role []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Role []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Role [] Parameters # Name Type partialItems Role [] \u00abdestructured\u00bb MergeItemsOptions Returns # Role [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Role > Parameters # Name Type item Role patch Patch Returns # Promise < Role > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Role [] Parameters # Name Type items Role [] Returns # Role [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Role []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Role []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Role Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Role request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Role [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Role Returns # void Inherited from # KubeObjectStore.select sortItems # \u25b8 Protected sortItems ( items ): Role [] Parameters # Name Type items Role [] Returns # Role [] Overrides # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Role Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Role [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Role Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Role > Parameters # Name Type item Role data PartialObjectDeep < Role > Returns # Promise < Role > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Role > Parameters # Name Type item Role request () => Promise < Role > Returns # Promise < Role > Inherited from # KubeObjectStore.updateItem","title":"Class: RolesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#class-rolesstore","text":"Renderer . K8sApi .RolesStore","title":"Class: RolesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#hierarchy","text":"KubeObjectStore < Role , RoleApi , RoleData > \u21b3 RolesStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#constructor","text":"\u2022 new RolesStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#api","text":"\u2022 Readonly api : RoleApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Role ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < RoleData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#items","text":"\u2022 items : IObservableArray < Role >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#iterator","text":"\u25b8 [iterator] (): Generator < Role , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#create","text":"\u25b8 create ( params , data? ): Promise < Role >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Role >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Role []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Role []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Role","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Role []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Role","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Role","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getitems","text":"\u25b8 getItems (): Role []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#load","text":"\u25b8 load ( params ): Promise < Role >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Role []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Role >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Role >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Role []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Role []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Role >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Role []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Role []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#sortitems","text":"\u25b8 Protected sortItems ( items ): Role []","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#update","text":"\u25b8 update ( item , data ): Promise < Role >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Role >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/","text":"Class: SecretsStore # Renderer . K8sApi .SecretsStore Hierarchy # KubeObjectStore < Secret , SecretApi , SecretData > \u21b3 SecretsStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new SecretsStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api SecretApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : SecretApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Secret ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Secret Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < SecretData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Secret > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Secret , void , undefined > Returns # Generator < Secret , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Secret > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Secret > Returns # Promise < Secret > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Secret > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Secret > Returns # Promise < null | Secret > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Secret [] Parameters # Name Type items Secret [] Returns # Secret [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Secret [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Secret [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Secret Parameters # Name Type id string Returns # undefined | Secret Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Secret [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Secret [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Secret Parameters # Name Type name string namespace? string Returns # undefined | Secret Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Secret Parameters # Name Type path string Returns # undefined | Secret Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Secret [] Returns # Secret [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Secret Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Secret [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Secret > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Secret > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Secret []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Secret []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Secret > Parameters # Name Type resourcePath string Returns # Promise < Secret > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Secret > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Secret > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Secret []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Secret []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Secret [] Parameters # Name Type partialItems Secret [] \u00abdestructured\u00bb MergeItemsOptions Returns # Secret [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Secret > Parameters # Name Type item Secret patch Patch Returns # Promise < Secret > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Secret [] Parameters # Name Type items Secret [] Returns # Secret [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Secret []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Secret []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Secret Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Secret request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Secret [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Secret Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Secret [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Secret Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Secret [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Secret Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Secret > Parameters # Name Type item Secret data PartialObjectDeep < Secret > Returns # Promise < Secret > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Secret > Parameters # Name Type item Secret request () => Promise < Secret > Returns # Promise < Secret > Inherited from # KubeObjectStore.updateItem","title":"Class: SecretsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#class-secretsstore","text":"Renderer . K8sApi .SecretsStore","title":"Class: SecretsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#hierarchy","text":"KubeObjectStore < Secret , SecretApi , SecretData > \u21b3 SecretsStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#constructor","text":"\u2022 new SecretsStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#api","text":"\u2022 Readonly api : SecretApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Secret ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < SecretData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#items","text":"\u2022 items : IObservableArray < Secret >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#iterator","text":"\u25b8 [iterator] (): Generator < Secret , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#create","text":"\u25b8 create ( params , data? ): Promise < Secret >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Secret >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Secret []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Secret []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Secret","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Secret []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Secret","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Secret","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getitems","text":"\u25b8 getItems (): Secret []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#load","text":"\u25b8 load ( params ): Promise < Secret >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Secret []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Secret >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Secret >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Secret []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Secret []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Secret >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Secret []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Secret []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#update","text":"\u25b8 update ( item , data ): Promise < Secret >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Secret >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/","text":"Class: ServiceAccountsStore # Renderer . K8sApi .ServiceAccountsStore Hierarchy # KubeObjectStore < ServiceAccount , ServiceAccountApi , ServiceAccountData > \u21b3 ServiceAccountsStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ServiceAccountsStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api ServiceAccountApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : ServiceAccountApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : ServiceAccount ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item ServiceAccount Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < ServiceAccountData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < ServiceAccount > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < ServiceAccount , void , undefined > Returns # Generator < ServiceAccount , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < ServiceAccount > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < ServiceAccount > Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params ): Promise < null | ServiceAccount > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | ServiceAccount > Overrides # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): ServiceAccount [] Parameters # Name Type items ServiceAccount [] Returns # ServiceAccount [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): ServiceAccount [] Parameters # Name Type namespace string | string [] strict? boolean Returns # ServiceAccount [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | ServiceAccount Parameters # Name Type id string Returns # undefined | ServiceAccount Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): ServiceAccount [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # ServiceAccount [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | ServiceAccount Parameters # Name Type name string namespace? string Returns # undefined | ServiceAccount Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | ServiceAccount Parameters # Name Type path string Returns # undefined | ServiceAccount Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): ServiceAccount [] Returns # ServiceAccount [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item ServiceAccount Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? ServiceAccount [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < ServiceAccount > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ServiceAccount []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | ServiceAccount []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < ServiceAccount > Parameters # Name Type resourcePath string Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | ServiceAccount > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | ServiceAccount > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ServiceAccount []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < ServiceAccount []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ServiceAccount [] Parameters # Name Type partialItems ServiceAccount [] \u00abdestructured\u00bb MergeItemsOptions Returns # ServiceAccount [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < ServiceAccount > Parameters # Name Type item ServiceAccount patch Patch Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): ServiceAccount [] Parameters # Name Type items ServiceAccount [] Returns # ServiceAccount [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | ServiceAccount []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | ServiceAccount []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item ServiceAccount Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item ServiceAccount request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items ServiceAccount [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item ServiceAccount Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # ServiceAccount [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item ServiceAccount Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? ServiceAccount [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item ServiceAccount Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < ServiceAccount > Parameters # Name Type item ServiceAccount data PartialObjectDeep < ServiceAccount > Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < ServiceAccount > Parameters # Name Type item ServiceAccount request () => Promise < ServiceAccount > Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore.updateItem","title":"Class: ServiceAccountsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#class-serviceaccountsstore","text":"Renderer . K8sApi .ServiceAccountsStore","title":"Class: ServiceAccountsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#hierarchy","text":"KubeObjectStore < ServiceAccount , ServiceAccountApi , ServiceAccountData > \u21b3 ServiceAccountsStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#constructor","text":"\u2022 new ServiceAccountsStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#api","text":"\u2022 Readonly api : ServiceAccountApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : ServiceAccount ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < ServiceAccountData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#items","text":"\u2022 items : IObservableArray < ServiceAccount >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#iterator","text":"\u25b8 [iterator] (): Generator < ServiceAccount , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#create","text":"\u25b8 create ( params , data? ): Promise < ServiceAccount >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#createitem","text":"\u25b8 Protected createItem ( params ): Promise < null | ServiceAccount >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): ServiceAccount []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): ServiceAccount []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbyid","text":"\u25b8 getById ( id ): undefined | ServiceAccount","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): ServiceAccount []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | ServiceAccount","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | ServiceAccount","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getitems","text":"\u25b8 getItems (): ServiceAccount []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#load","text":"\u25b8 load ( params ): Promise < ServiceAccount >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ServiceAccount []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < ServiceAccount >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | ServiceAccount >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ServiceAccount []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ServiceAccount []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < ServiceAccount >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): ServiceAccount []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | ServiceAccount []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#update","text":"\u25b8 update ( item , data ): Promise < ServiceAccount >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < ServiceAccount >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/","text":"Class: ServiceStore # Renderer . K8sApi .ServiceStore Hierarchy # KubeObjectStore < Service , ServiceApi > \u21b3 ServiceStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ServiceStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api ServiceApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : ServiceApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Service ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Service Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , ServiceStatus , ServiceSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Service > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Service , void , undefined > Returns # Generator < Service , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Service > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Service > Returns # Promise < Service > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Service > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Service > Returns # Promise < null | Service > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Service [] Parameters # Name Type items Service [] Returns # Service [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Service [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Service [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Service Parameters # Name Type id string Returns # undefined | Service Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Service [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Service [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Service Parameters # Name Type name string namespace? string Returns # undefined | Service Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Service Parameters # Name Type path string Returns # undefined | Service Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Service [] Returns # Service [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Service Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Service [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Service > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Service > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Service []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Service []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Service > Parameters # Name Type resourcePath string Returns # Promise < Service > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Service > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Service > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Service []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Service []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Service [] Parameters # Name Type partialItems Service [] \u00abdestructured\u00bb MergeItemsOptions Returns # Service [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Service > Parameters # Name Type item Service patch Patch Returns # Promise < Service > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Service [] Parameters # Name Type items Service [] Returns # Service [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Service []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Service []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Service Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Service request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Service [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Service Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Service [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Service Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Service [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Service Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Service > Parameters # Name Type item Service data PartialObjectDeep < Service > Returns # Promise < Service > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Service > Parameters # Name Type item Service request () => Promise < Service > Returns # Promise < Service > Inherited from # KubeObjectStore.updateItem","title":"Class: ServiceStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#class-servicestore","text":"Renderer . K8sApi .ServiceStore","title":"Class: ServiceStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#hierarchy","text":"KubeObjectStore < Service , ServiceApi > \u21b3 ServiceStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#constructor","text":"\u2022 new ServiceStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#api","text":"\u2022 Readonly api : ServiceApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Service ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , ServiceStatus , ServiceSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#items","text":"\u2022 items : IObservableArray < Service >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#iterator","text":"\u25b8 [iterator] (): Generator < Service , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#create","text":"\u25b8 create ( params , data? ): Promise < Service >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Service >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Service []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Service []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Service","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Service []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Service","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Service","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getitems","text":"\u25b8 getItems (): Service []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#load","text":"\u25b8 load ( params ): Promise < Service >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Service []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Service >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Service >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Service []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Service []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Service >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Service []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Service []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#update","text":"\u25b8 update ( item , data ): Promise < Service >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Service >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/","text":"Class: StatefulSetStore # Renderer . K8sApi .StatefulSetStore Hierarchy # KubeObjectStore < StatefulSet , StatefulSetApi > \u21b3 StatefulSetStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new StatefulSetStore ( dependencies , api , opts? ) Parameters # Name Type dependencies Dependencies api StatefulSetApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : StatefulSetApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : StatefulSet ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item StatefulSet Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : Dependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , StatefulSetStatus , StatefulSetSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < StatefulSet > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < StatefulSet , void , undefined > Returns # Generator < StatefulSet , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < StatefulSet > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < StatefulSet > Returns # Promise < StatefulSet > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | StatefulSet > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < StatefulSet > Returns # Promise < null | StatefulSet > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): StatefulSet [] Parameters # Name Type items StatefulSet [] Returns # StatefulSet [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): StatefulSet [] Parameters # Name Type namespace string | string [] strict? boolean Returns # StatefulSet [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | StatefulSet Parameters # Name Type id string Returns # undefined | StatefulSet Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): StatefulSet [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # StatefulSet [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | StatefulSet Parameters # Name Type name string namespace? string Returns # undefined | StatefulSet Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | StatefulSet Parameters # Name Type path string Returns # undefined | StatefulSet Inherited from # KubeObjectStore.getByPath getChildPods # \u25b8 getChildPods ( statefulSet ): Pod [] Parameters # Name Type statefulSet StatefulSet Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): StatefulSet [] Returns # StatefulSet [] Inherited from # KubeObjectStore.getItems getStatuses # \u25b8 getStatuses ( statefulSets ): Object Parameters # Name Type statefulSets StatefulSet [] Returns # Object Name Type failed number pending number running number getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item StatefulSet Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? StatefulSet [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < StatefulSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < StatefulSet > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | StatefulSet []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | StatefulSet []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < StatefulSet > Parameters # Name Type resourcePath string Returns # Promise < StatefulSet > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | StatefulSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | StatefulSet > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < StatefulSet []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < StatefulSet []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): StatefulSet [] Parameters # Name Type partialItems StatefulSet [] \u00abdestructured\u00bb MergeItemsOptions Returns # StatefulSet [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < StatefulSet > Parameters # Name Type item StatefulSet patch Patch Returns # Promise < StatefulSet > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): StatefulSet [] Parameters # Name Type items StatefulSet [] Returns # StatefulSet [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | StatefulSet []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | StatefulSet []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item StatefulSet Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item StatefulSet request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items StatefulSet [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item StatefulSet Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # StatefulSet [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item StatefulSet Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? StatefulSet [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item StatefulSet Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < StatefulSet > Parameters # Name Type item StatefulSet data PartialObjectDeep < StatefulSet > Returns # Promise < StatefulSet > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < StatefulSet > Parameters # Name Type item StatefulSet request () => Promise < StatefulSet > Returns # Promise < StatefulSet > Inherited from # KubeObjectStore.updateItem","title":"Class: StatefulSetStore"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#class-statefulsetstore","text":"Renderer . K8sApi .StatefulSetStore","title":"Class: StatefulSetStore"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#hierarchy","text":"KubeObjectStore < StatefulSet , StatefulSetApi > \u21b3 StatefulSetStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#constructor","text":"\u2022 new StatefulSetStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#api","text":"\u2022 Readonly api : StatefulSetApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : StatefulSet ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#dependencies","text":"\u2022 Protected Readonly dependencies : Dependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , StatefulSetStatus , StatefulSetSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#items","text":"\u2022 items : IObservableArray < StatefulSet >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#iterator","text":"\u25b8 [iterator] (): Generator < StatefulSet , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#create","text":"\u25b8 create ( params , data? ): Promise < StatefulSet >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | StatefulSet >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): StatefulSet []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): StatefulSet []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbyid","text":"\u25b8 getById ( id ): undefined | StatefulSet","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): StatefulSet []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | StatefulSet","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | StatefulSet","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getchildpods","text":"\u25b8 getChildPods ( statefulSet ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getitems","text":"\u25b8 getItems (): StatefulSet []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getstatuses","text":"\u25b8 getStatuses ( statefulSets ): Object","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#load","text":"\u25b8 load ( params ): Promise < StatefulSet >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | StatefulSet []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < StatefulSet >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | StatefulSet >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < StatefulSet []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): StatefulSet []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < StatefulSet >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): StatefulSet []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | StatefulSet []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#update","text":"\u25b8 update ( item , data ): Promise < StatefulSet >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < StatefulSet >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/","text":"Class: StorageClassStore # Renderer . K8sApi .StorageClassStore Hierarchy # KubeObjectStore < StorageClass , StorageClassApi , StorageClassData > \u21b3 StorageClassStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getPersistentVolumes getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new StorageClassStore ( dependencies , api , opts? ) Parameters # Name Type dependencies StorageClassStoreDependencies api StorageClassApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : StorageClassApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : StorageClass ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item StorageClass Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : StorageClassStoreDependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < StorageClassData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < StorageClass > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < StorageClass , void , undefined > Returns # Generator < StorageClass , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < StorageClass > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < StorageClass > Returns # Promise < StorageClass > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | StorageClass > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < StorageClass > Returns # Promise < null | StorageClass > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): StorageClass [] Parameters # Name Type items StorageClass [] Returns # StorageClass [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): StorageClass [] Parameters # Name Type namespace string | string [] strict? boolean Returns # StorageClass [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | StorageClass Parameters # Name Type id string Returns # undefined | StorageClass Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): StorageClass [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # StorageClass [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | StorageClass Parameters # Name Type name string namespace? string Returns # undefined | StorageClass Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | StorageClass Parameters # Name Type path string Returns # undefined | StorageClass Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): StorageClass [] Returns # StorageClass [] Inherited from # KubeObjectStore.getItems getPersistentVolumes # \u25b8 getPersistentVolumes ( storageClass ): PersistentVolume [] Parameters # Name Type storageClass StorageClass Returns # PersistentVolume [] getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item StorageClass Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? StorageClass [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < StorageClass > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < StorageClass > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | StorageClass []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | StorageClass []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < StorageClass > Parameters # Name Type resourcePath string Returns # Promise < StorageClass > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | StorageClass > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | StorageClass > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < StorageClass []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < StorageClass []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): StorageClass [] Parameters # Name Type partialItems StorageClass [] \u00abdestructured\u00bb MergeItemsOptions Returns # StorageClass [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < StorageClass > Parameters # Name Type item StorageClass patch Patch Returns # Promise < StorageClass > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): StorageClass [] Parameters # Name Type items StorageClass [] Returns # StorageClass [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | StorageClass []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | StorageClass []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item StorageClass Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item StorageClass request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items StorageClass [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item StorageClass Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # StorageClass [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item StorageClass Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? StorageClass [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item StorageClass Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < StorageClass > Parameters # Name Type item StorageClass data PartialObjectDeep < StorageClass > Returns # Promise < StorageClass > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < StorageClass > Parameters # Name Type item StorageClass request () => Promise < StorageClass > Returns # Promise < StorageClass > Inherited from # KubeObjectStore.updateItem","title":"Class: StorageClassStore"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#class-storageclassstore","text":"Renderer . K8sApi .StorageClassStore","title":"Class: StorageClassStore"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#hierarchy","text":"KubeObjectStore < StorageClass , StorageClassApi , StorageClassData > \u21b3 StorageClassStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getPersistentVolumes getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#constructor","text":"\u2022 new StorageClassStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#api","text":"\u2022 Readonly api : StorageClassApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : StorageClass ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#dependencies","text":"\u2022 Protected Readonly dependencies : StorageClassStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < StorageClassData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#items","text":"\u2022 items : IObservableArray < StorageClass >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#iterator","text":"\u25b8 [iterator] (): Generator < StorageClass , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#create","text":"\u25b8 create ( params , data? ): Promise < StorageClass >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | StorageClass >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): StorageClass []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): StorageClass []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbyid","text":"\u25b8 getById ( id ): undefined | StorageClass","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): StorageClass []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | StorageClass","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | StorageClass","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getitems","text":"\u25b8 getItems (): StorageClass []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getpersistentvolumes","text":"\u25b8 getPersistentVolumes ( storageClass ): PersistentVolume []","title":"getPersistentVolumes"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#load","text":"\u25b8 load ( params ): Promise < StorageClass >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | StorageClass []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < StorageClass >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | StorageClass >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < StorageClass []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): StorageClass []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < StorageClass >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): StorageClass []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | StorageClass []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#update","text":"\u25b8 update ( item , data ): Promise < StorageClass >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < StorageClass >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/","text":"Class: VerticalPodAutoscalerStore # Renderer . K8sApi .VerticalPodAutoscalerStore Hierarchy # KubeObjectStore < VerticalPodAutoscaler , VerticalPodAutoscalerApi > \u21b3 VerticalPodAutoscalerStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new VerticalPodAutoscalerStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api VerticalPodAutoscalerApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : VerticalPodAutoscalerApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : VerticalPodAutoscaler ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item VerticalPodAutoscaler Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , VerticalPodAutoscalerStatus , VerticalPodAutoscalerSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < VerticalPodAutoscaler > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < VerticalPodAutoscaler , void , undefined > Returns # Generator < VerticalPodAutoscaler , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < VerticalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < VerticalPodAutoscaler > Returns # Promise < VerticalPodAutoscaler > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | VerticalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < VerticalPodAutoscaler > Returns # Promise < null | VerticalPodAutoscaler > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): VerticalPodAutoscaler [] Parameters # Name Type items VerticalPodAutoscaler [] Returns # VerticalPodAutoscaler [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): VerticalPodAutoscaler [] Parameters # Name Type namespace string | string [] strict? boolean Returns # VerticalPodAutoscaler [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | VerticalPodAutoscaler Parameters # Name Type id string Returns # undefined | VerticalPodAutoscaler Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): VerticalPodAutoscaler [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # VerticalPodAutoscaler [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | VerticalPodAutoscaler Parameters # Name Type name string namespace? string Returns # undefined | VerticalPodAutoscaler Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | VerticalPodAutoscaler Parameters # Name Type path string Returns # undefined | VerticalPodAutoscaler Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): VerticalPodAutoscaler [] Returns # VerticalPodAutoscaler [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item VerticalPodAutoscaler Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? VerticalPodAutoscaler [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < VerticalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < VerticalPodAutoscaler > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | VerticalPodAutoscaler []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | VerticalPodAutoscaler []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < VerticalPodAutoscaler > Parameters # Name Type resourcePath string Returns # Promise < VerticalPodAutoscaler > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | VerticalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | VerticalPodAutoscaler > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < VerticalPodAutoscaler []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < VerticalPodAutoscaler []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): VerticalPodAutoscaler [] Parameters # Name Type partialItems VerticalPodAutoscaler [] \u00abdestructured\u00bb MergeItemsOptions Returns # VerticalPodAutoscaler [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < VerticalPodAutoscaler > Parameters # Name Type item VerticalPodAutoscaler patch Patch Returns # Promise < VerticalPodAutoscaler > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): VerticalPodAutoscaler [] Parameters # Name Type items VerticalPodAutoscaler [] Returns # VerticalPodAutoscaler [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | VerticalPodAutoscaler []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | VerticalPodAutoscaler []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item VerticalPodAutoscaler Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item VerticalPodAutoscaler request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items VerticalPodAutoscaler [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item VerticalPodAutoscaler Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # VerticalPodAutoscaler [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item VerticalPodAutoscaler Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? VerticalPodAutoscaler [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item VerticalPodAutoscaler Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < VerticalPodAutoscaler > Parameters # Name Type item VerticalPodAutoscaler data PartialObjectDeep < VerticalPodAutoscaler > Returns # Promise < VerticalPodAutoscaler > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < VerticalPodAutoscaler > Parameters # Name Type item VerticalPodAutoscaler request () => Promise < VerticalPodAutoscaler > Returns # Promise < VerticalPodAutoscaler > Inherited from # KubeObjectStore.updateItem","title":"Class: VerticalPodAutoscalerStore"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#class-verticalpodautoscalerstore","text":"Renderer . K8sApi .VerticalPodAutoscalerStore","title":"Class: VerticalPodAutoscalerStore"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#hierarchy","text":"KubeObjectStore < VerticalPodAutoscaler , VerticalPodAutoscalerApi > \u21b3 VerticalPodAutoscalerStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#constructor","text":"\u2022 new VerticalPodAutoscalerStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#api","text":"\u2022 Readonly api : VerticalPodAutoscalerApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : VerticalPodAutoscaler ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , VerticalPodAutoscalerStatus , VerticalPodAutoscalerSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#items","text":"\u2022 items : IObservableArray < VerticalPodAutoscaler >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#iterator","text":"\u25b8 [iterator] (): Generator < VerticalPodAutoscaler , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#create","text":"\u25b8 create ( params , data? ): Promise < VerticalPodAutoscaler >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | VerticalPodAutoscaler >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): VerticalPodAutoscaler []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): VerticalPodAutoscaler []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbyid","text":"\u25b8 getById ( id ): undefined | VerticalPodAutoscaler","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): VerticalPodAutoscaler []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | VerticalPodAutoscaler","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | VerticalPodAutoscaler","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getitems","text":"\u25b8 getItems (): VerticalPodAutoscaler []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#load","text":"\u25b8 load ( params ): Promise < VerticalPodAutoscaler >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | VerticalPodAutoscaler []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < VerticalPodAutoscaler >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | VerticalPodAutoscaler >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < VerticalPodAutoscaler []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): VerticalPodAutoscaler []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < VerticalPodAutoscaler >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): VerticalPodAutoscaler []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | VerticalPodAutoscaler []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#update","text":"\u25b8 update ( item , data ): Promise < VerticalPodAutoscaler >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < VerticalPodAutoscaler >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/","text":"Class: VolumeClaimStore # Renderer . K8sApi .VolumeClaimStore Hierarchy # KubeObjectStore < PersistentVolumeClaim , PersistentVolumeClaimApi > \u21b3 VolumeClaimStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new VolumeClaimStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api PersistentVolumeClaimApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : PersistentVolumeClaimApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : PersistentVolumeClaim ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item PersistentVolumeClaim Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , PersistentVolumeClaimStatus , PersistentVolumeClaimSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < PersistentVolumeClaim > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < PersistentVolumeClaim , void , undefined > Returns # Generator < PersistentVolumeClaim , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < PersistentVolumeClaim > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PersistentVolumeClaim > Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | PersistentVolumeClaim > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PersistentVolumeClaim > Returns # Promise < null | PersistentVolumeClaim > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): PersistentVolumeClaim [] Parameters # Name Type items PersistentVolumeClaim [] Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): PersistentVolumeClaim [] Parameters # Name Type namespace string | string [] strict? boolean Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | PersistentVolumeClaim Parameters # Name Type id string Returns # undefined | PersistentVolumeClaim Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): PersistentVolumeClaim [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | PersistentVolumeClaim Parameters # Name Type name string namespace? string Returns # undefined | PersistentVolumeClaim Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | PersistentVolumeClaim Parameters # Name Type path string Returns # undefined | PersistentVolumeClaim Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): PersistentVolumeClaim [] Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item PersistentVolumeClaim Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? PersistentVolumeClaim [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < PersistentVolumeClaim > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PersistentVolumeClaim []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | PersistentVolumeClaim []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < PersistentVolumeClaim > Parameters # Name Type resourcePath string Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | PersistentVolumeClaim > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | PersistentVolumeClaim > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PersistentVolumeClaim []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < PersistentVolumeClaim []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PersistentVolumeClaim [] Parameters # Name Type partialItems PersistentVolumeClaim [] \u00abdestructured\u00bb MergeItemsOptions Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < PersistentVolumeClaim > Parameters # Name Type item PersistentVolumeClaim patch Patch Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): PersistentVolumeClaim [] Parameters # Name Type items PersistentVolumeClaim [] Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | PersistentVolumeClaim []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | PersistentVolumeClaim []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item PersistentVolumeClaim Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item PersistentVolumeClaim request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items PersistentVolumeClaim [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item PersistentVolumeClaim Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item PersistentVolumeClaim Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? PersistentVolumeClaim [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item PersistentVolumeClaim Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < PersistentVolumeClaim > Parameters # Name Type item PersistentVolumeClaim data PartialObjectDeep < PersistentVolumeClaim > Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < PersistentVolumeClaim > Parameters # Name Type item PersistentVolumeClaim request () => Promise < PersistentVolumeClaim > Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore.updateItem","title":"Class: VolumeClaimStore"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#class-volumeclaimstore","text":"Renderer . K8sApi .VolumeClaimStore","title":"Class: VolumeClaimStore"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#hierarchy","text":"KubeObjectStore < PersistentVolumeClaim , PersistentVolumeClaimApi > \u21b3 VolumeClaimStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#constructor","text":"\u2022 new VolumeClaimStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#api","text":"\u2022 Readonly api : PersistentVolumeClaimApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : PersistentVolumeClaim ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , PersistentVolumeClaimStatus , PersistentVolumeClaimSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#items","text":"\u2022 items : IObservableArray < PersistentVolumeClaim >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#iterator","text":"\u25b8 [iterator] (): Generator < PersistentVolumeClaim , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#create","text":"\u25b8 create ( params , data? ): Promise < PersistentVolumeClaim >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | PersistentVolumeClaim >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): PersistentVolumeClaim []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): PersistentVolumeClaim []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbyid","text":"\u25b8 getById ( id ): undefined | PersistentVolumeClaim","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): PersistentVolumeClaim []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | PersistentVolumeClaim","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | PersistentVolumeClaim","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getitems","text":"\u25b8 getItems (): PersistentVolumeClaim []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#load","text":"\u25b8 load ( params ): Promise < PersistentVolumeClaim >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PersistentVolumeClaim []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < PersistentVolumeClaim >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | PersistentVolumeClaim >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PersistentVolumeClaim []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PersistentVolumeClaim []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < PersistentVolumeClaim >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): PersistentVolumeClaim []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | PersistentVolumeClaim []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#update","text":"\u25b8 update ( item , data ): Promise < PersistentVolumeClaim >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < PersistentVolumeClaim >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.LensExtension/","text":"Class: LensExtension # Renderer .LensExtension Hierarchy # LensExtension < LensRendererExtensionDependencies > \u21b3 LensExtension Table of contents # Constructors # constructor Properties # additionalCategoryColumns appPreferenceTabs appPreferences catalogEntityDetailItems clusterFrameComponents clusterPageMenus clusterPages commands customCategoryViews entitySettings globalPages id isBundled kubeObjectDetailItems kubeObjectHandlers kubeObjectMenuItems kubeObjectStatusTexts kubeWorkloadsOverviewItems manifest manifestPath protocolHandlers statusBarItems topBarItems welcomeBanners welcomeMenus Accessors # description isEnabled name sanitizedExtensionId storeName version Methods # activate addCatalogCategoryFilter addCatalogFilter disable enable getExtensionFileFolder isEnabledForCluster navigate onActivate onDeactivate Constructors # constructor # \u2022 new LensExtension ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb InstalledExtension Inherited from # LensExtension . constructor Properties # additionalCategoryColumns # \u2022 additionalCategoryColumns : AdditionalCategoryColumnRegistration [] appPreferenceTabs # \u2022 appPreferenceTabs : AppPreferenceTabRegistration [] appPreferences # \u2022 appPreferences : AppPreferenceRegistration [] catalogEntityDetailItems # \u2022 catalogEntityDetailItems : CatalogEntityDetailRegistration < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >>[] clusterFrameComponents # \u2022 clusterFrameComponents : ClusterFrameChildComponent [] clusterPageMenus # \u2022 clusterPageMenus : ClusterPageMenuRegistration [] clusterPages # \u2022 clusterPages : PageRegistration [] commands # \u2022 commands : CommandRegistration [] customCategoryViews # \u2022 customCategoryViews : CustomCategoryViewRegistration [] entitySettings # \u2022 entitySettings : EntitySettingRegistration [] globalPages # \u2022 globalPages : PageRegistration [] id # \u2022 Readonly id : string Inherited from # LensExtension . id isBundled # \u2022 Readonly isBundled : boolean Inherited from # LensExtension . isBundled kubeObjectDetailItems # \u2022 kubeObjectDetailItems : KubeObjectDetailRegistration < KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >>[] kubeObjectHandlers # \u2022 kubeObjectHandlers : KubeObjectHandlerRegistration [] kubeObjectMenuItems # \u2022 kubeObjectMenuItems : KubeObjectMenuRegistration [] kubeObjectStatusTexts # \u2022 kubeObjectStatusTexts : KubeObjectStatusRegistration [] kubeWorkloadsOverviewItems # \u2022 kubeWorkloadsOverviewItems : WorkloadsOverviewDetailRegistration [] manifest # \u2022 Readonly manifest : LensExtensionManifest Inherited from # LensExtension . manifest manifestPath # \u2022 Readonly manifestPath : string Inherited from # LensExtension . manifestPath protocolHandlers # \u2022 protocolHandlers : ProtocolHandlerRegistration [] Inherited from # LensExtension . protocolHandlers statusBarItems # \u2022 statusBarItems : StatusBarRegistration [] topBarItems # \u2022 topBarItems : TopBarRegistration [] welcomeBanners # \u2022 welcomeBanners : WelcomeBannerRegistration [] welcomeMenus # \u2022 welcomeMenus : WelcomeMenuRegistration [] Accessors # description # \u2022 get description (): undefined | string Returns # undefined | string Inherited from # LensExtension.description isEnabled # \u2022 get isEnabled (): boolean Returns # boolean Inherited from # LensExtension.isEnabled name # \u2022 get name (): string Returns # string Inherited from # LensExtension.name sanitizedExtensionId # \u2022 get sanitizedExtensionId (): string Returns # string Inherited from # LensExtension.sanitizedExtensionId storeName # \u2022 get storeName (): string Returns # string Inherited from # LensExtension.storeName version # \u2022 get version (): string Returns # string Inherited from # LensExtension.version Methods # activate # \u25b8 activate (): Promise < void > Returns # Promise < void > Inherited from # LensExtension . activate addCatalogCategoryFilter # \u25b8 addCatalogCategoryFilter ( fn ): Disposer Add a filtering function for the catalog categories. This will be removed if the extension is disabled. Parameters # Name Type Description fn CategoryFilter The function which should return a truthy value for those categories which should be kept. Returns # Disposer A function to clean up the filter addCatalogFilter # \u25b8 addCatalogFilter ( fn ): Disposer Add a filtering function for the catalog entities. This will be removed if the extension is disabled. Parameters # Name Type Description fn EntityFilter The function which should return a truthy value for those entities which should be kept. Returns # Disposer A function to clean up the filter disable # \u25b8 disable (): Promise < void > Returns # Promise < void > Inherited from # LensExtension . disable enable # \u25b8 enable (): Promise < void > Returns # Promise < void > Inherited from # LensExtension . enable getExtensionFileFolder # \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. Returns # Promise < string > Inherited from # LensExtension . getExtensionFileFolder isEnabledForCluster # \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 Parameters # Name Type cluster KubernetesCluster < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > Returns # Promise < Boolean > navigate # \u25b8 navigate ( pageId? , params? ): Promise < void > Parameters # Name Type pageId? string params? object Returns # Promise < void > onActivate # \u25b8 Protected onActivate (): void | Promise < void > Returns # void | Promise < void > Inherited from # LensExtension . onActivate onDeactivate # \u25b8 Protected onDeactivate (): void | Promise < void > Returns # void | Promise < void > Inherited from # LensExtension . onDeactivate","title":"Class: LensExtension"},{"location":"extensions/api/classes/Renderer.LensExtension/#class-lensextension","text":"Renderer .LensExtension","title":"Class: LensExtension"},{"location":"extensions/api/classes/Renderer.LensExtension/#hierarchy","text":"LensExtension < LensRendererExtensionDependencies > \u21b3 LensExtension","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.LensExtension/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.LensExtension/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.LensExtension/#properties","text":"additionalCategoryColumns appPreferenceTabs appPreferences catalogEntityDetailItems clusterFrameComponents clusterPageMenus clusterPages commands customCategoryViews entitySettings globalPages id isBundled kubeObjectDetailItems kubeObjectHandlers kubeObjectMenuItems kubeObjectStatusTexts kubeWorkloadsOverviewItems manifest manifestPath protocolHandlers statusBarItems topBarItems welcomeBanners welcomeMenus","title":"Properties"},{"location":"extensions/api/classes/Renderer.LensExtension/#accessors","text":"description isEnabled name sanitizedExtensionId storeName version","title":"Accessors"},{"location":"extensions/api/classes/Renderer.LensExtension/#methods","text":"activate addCatalogCategoryFilter addCatalogFilter disable enable getExtensionFileFolder isEnabledForCluster navigate onActivate onDeactivate","title":"Methods"},{"location":"extensions/api/classes/Renderer.LensExtension/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.LensExtension/#constructor","text":"\u2022 new LensExtension ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Renderer.LensExtension/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.LensExtension/#additionalcategorycolumns","text":"\u2022 additionalCategoryColumns : AdditionalCategoryColumnRegistration []","title":"additionalCategoryColumns"},{"location":"extensions/api/classes/Renderer.LensExtension/#apppreferencetabs","text":"\u2022 appPreferenceTabs : AppPreferenceTabRegistration []","title":"appPreferenceTabs"},{"location":"extensions/api/classes/Renderer.LensExtension/#apppreferences","text":"\u2022 appPreferences : AppPreferenceRegistration []","title":"appPreferences"},{"location":"extensions/api/classes/Renderer.LensExtension/#catalogentitydetailitems","text":"\u2022 catalogEntityDetailItems : CatalogEntityDetailRegistration < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >>[]","title":"catalogEntityDetailItems"},{"location":"extensions/api/classes/Renderer.LensExtension/#clusterframecomponents","text":"\u2022 clusterFrameComponents : ClusterFrameChildComponent []","title":"clusterFrameComponents"},{"location":"extensions/api/classes/Renderer.LensExtension/#clusterpagemenus","text":"\u2022 clusterPageMenus : ClusterPageMenuRegistration []","title":"clusterPageMenus"},{"location":"extensions/api/classes/Renderer.LensExtension/#clusterpages","text":"\u2022 clusterPages : PageRegistration []","title":"clusterPages"},{"location":"extensions/api/classes/Renderer.LensExtension/#commands","text":"\u2022 commands : CommandRegistration []","title":"commands"},{"location":"extensions/api/classes/Renderer.LensExtension/#customcategoryviews","text":"\u2022 customCategoryViews : CustomCategoryViewRegistration []","title":"customCategoryViews"},{"location":"extensions/api/classes/Renderer.LensExtension/#entitysettings","text":"\u2022 entitySettings : EntitySettingRegistration []","title":"entitySettings"},{"location":"extensions/api/classes/Renderer.LensExtension/#globalpages","text":"\u2022 globalPages : PageRegistration []","title":"globalPages"},{"location":"extensions/api/classes/Renderer.LensExtension/#id","text":"\u2022 Readonly id : string","title":"id"},{"location":"extensions/api/classes/Renderer.LensExtension/#isbundled","text":"\u2022 Readonly isBundled : boolean","title":"isBundled"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjectdetailitems","text":"\u2022 kubeObjectDetailItems : KubeObjectDetailRegistration < KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >>[]","title":"kubeObjectDetailItems"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjecthandlers","text":"\u2022 kubeObjectHandlers : KubeObjectHandlerRegistration []","title":"kubeObjectHandlers"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjectmenuitems","text":"\u2022 kubeObjectMenuItems : KubeObjectMenuRegistration []","title":"kubeObjectMenuItems"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjectstatustexts","text":"\u2022 kubeObjectStatusTexts : KubeObjectStatusRegistration []","title":"kubeObjectStatusTexts"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeworkloadsoverviewitems","text":"\u2022 kubeWorkloadsOverviewItems : WorkloadsOverviewDetailRegistration []","title":"kubeWorkloadsOverviewItems"},{"location":"extensions/api/classes/Renderer.LensExtension/#manifest","text":"\u2022 Readonly manifest : LensExtensionManifest","title":"manifest"},{"location":"extensions/api/classes/Renderer.LensExtension/#manifestpath","text":"\u2022 Readonly manifestPath : string","title":"manifestPath"},{"location":"extensions/api/classes/Renderer.LensExtension/#protocolhandlers","text":"\u2022 protocolHandlers : ProtocolHandlerRegistration []","title":"protocolHandlers"},{"location":"extensions/api/classes/Renderer.LensExtension/#statusbaritems","text":"\u2022 statusBarItems : StatusBarRegistration []","title":"statusBarItems"},{"location":"extensions/api/classes/Renderer.LensExtension/#topbaritems","text":"\u2022 topBarItems : TopBarRegistration []","title":"topBarItems"},{"location":"extensions/api/classes/Renderer.LensExtension/#welcomebanners","text":"\u2022 welcomeBanners : WelcomeBannerRegistration []","title":"welcomeBanners"},{"location":"extensions/api/classes/Renderer.LensExtension/#welcomemenus","text":"\u2022 welcomeMenus : WelcomeMenuRegistration []","title":"welcomeMenus"},{"location":"extensions/api/classes/Renderer.LensExtension/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.LensExtension/#description","text":"\u2022 get description (): undefined | string","title":"description"},{"location":"extensions/api/classes/Renderer.LensExtension/#isenabled","text":"\u2022 get isEnabled (): boolean","title":"isEnabled"},{"location":"extensions/api/classes/Renderer.LensExtension/#name","text":"\u2022 get name (): string","title":"name"},{"location":"extensions/api/classes/Renderer.LensExtension/#sanitizedextensionid","text":"\u2022 get sanitizedExtensionId (): string","title":"sanitizedExtensionId"},{"location":"extensions/api/classes/Renderer.LensExtension/#storename","text":"\u2022 get storeName (): string","title":"storeName"},{"location":"extensions/api/classes/Renderer.LensExtension/#version","text":"\u2022 get version (): string","title":"version"},{"location":"extensions/api/classes/Renderer.LensExtension/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.LensExtension/#activate","text":"\u25b8 activate (): Promise < void >","title":"activate"},{"location":"extensions/api/classes/Renderer.LensExtension/#addcatalogcategoryfilter","text":"\u25b8 addCatalogCategoryFilter ( fn ): Disposer Add a filtering function for the catalog categories. This will be removed if the extension is disabled.","title":"addCatalogCategoryFilter"},{"location":"extensions/api/classes/Renderer.LensExtension/#addcatalogfilter","text":"\u25b8 addCatalogFilter ( fn ): Disposer Add a filtering function for the catalog entities. This will be removed if the extension is disabled.","title":"addCatalogFilter"},{"location":"extensions/api/classes/Renderer.LensExtension/#disable","text":"\u25b8 disable (): Promise < void >","title":"disable"},{"location":"extensions/api/classes/Renderer.LensExtension/#enable","text":"\u25b8 enable (): Promise < void >","title":"enable"},{"location":"extensions/api/classes/Renderer.LensExtension/#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.","title":"getExtensionFileFolder"},{"location":"extensions/api/classes/Renderer.LensExtension/#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","title":"isEnabledForCluster"},{"location":"extensions/api/classes/Renderer.LensExtension/#navigate","text":"\u25b8 navigate ( pageId? , params? ): Promise < void >","title":"navigate"},{"location":"extensions/api/classes/Renderer.LensExtension/#onactivate","text":"\u25b8 Protected onActivate (): void | Promise < void >","title":"onActivate"},{"location":"extensions/api/classes/Renderer.LensExtension/#ondeactivate","text":"\u25b8 Protected onDeactivate (): void | Promise < void >","title":"onDeactivate"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/","text":"Class: PageParam # Renderer . Navigation .PageParam Type parameters # Name Type Value any Table of contents # Constructors # constructor Properties # dependencies isMulti name Accessors # defaultValue Methods # clear get getRaw parse set setRaw stringify toString Constructors # constructor # \u2022 new PageParam < Value >( dependencies , init ) Type parameters # Name Type Value any Parameters # Name Type dependencies PageParamDependencies init PageParamInit < Value > Properties # dependencies # \u2022 Protected Readonly dependencies : PageParamDependencies isMulti # \u2022 Readonly isMulti : boolean name # \u2022 Readonly name : string Accessors # defaultValue # \u2022 get defaultValue (): undefined | Value Returns # undefined | Value Methods # clear # \u25b8 clear (): void Returns # void get # \u25b8 get (): Value Returns # Value getRaw # \u25b8 getRaw (): string | string [] Get stringified raw value(s) from document.location.search Returns # string | string [] parse # \u25b8 parse ( values ): Value Parameters # Name Type values string | string [] Returns # Value set # \u25b8 set ( value , \u00abdestructured\u00bb? ): void Parameters # Name Type value Value \u00abdestructured\u00bb Object \u203a mergeGlobals? boolean \u203a replaceHistory? boolean Returns # void setRaw # \u25b8 setRaw ( value ): void Set stringified raw value(s) and update document.location.search Parameters # Name Type value string | string [] Returns # void stringify # \u25b8 stringify ( value? ): string [] Parameters # Name Type value? Value Returns # string [] toString # \u25b8 toString ( \u00abdestructured\u00bb? ): string Parameters # Name Type \u00abdestructured\u00bb Object \u203a mergeGlobals? boolean \u203a value? Value Returns # string","title":"Class: PageParam"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#class-pageparamvalue","text":"Renderer . Navigation .PageParam","title":"Class: PageParam<Value>"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#type-parameters","text":"Name Type Value any","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#properties","text":"dependencies isMulti name","title":"Properties"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#accessors","text":"defaultValue","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#methods","text":"clear get getRaw parse set setRaw stringify toString","title":"Methods"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#constructor","text":"\u2022 new PageParam < Value >( dependencies , init )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#dependencies","text":"\u2022 Protected Readonly dependencies : PageParamDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#ismulti","text":"\u2022 Readonly isMulti : boolean","title":"isMulti"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#name","text":"\u2022 Readonly name : string","title":"name"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#defaultvalue","text":"\u2022 get defaultValue (): undefined | Value","title":"defaultValue"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#clear","text":"\u25b8 clear (): void","title":"clear"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#get","text":"\u25b8 get (): Value","title":"get"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#getraw","text":"\u25b8 getRaw (): string | string [] Get stringified raw value(s) from document.location.search","title":"getRaw"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parse","text":"\u25b8 parse ( values ): Value","title":"parse"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#set","text":"\u25b8 set ( value , \u00abdestructured\u00bb? ): void","title":"set"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#setraw","text":"\u25b8 setRaw ( value ): void Set stringified raw value(s) and update document.location.search","title":"setRaw"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#stringify","text":"\u25b8 stringify ( value? ): string []","title":"stringify"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#tostring","text":"\u25b8 toString ( \u00abdestructured\u00bb? ): string","title":"toString"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/","text":"Enumeration: NotificationStatus # Renderer . Component .NotificationStatus Table of contents # Enumeration Members # ERROR INFO OK Enumeration Members # ERROR # \u2022 ERROR = \"error\" INFO # \u2022 INFO = \"info\" OK # \u2022 OK = \"ok\"","title":"Enumeration: NotificationStatus"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#enumeration-notificationstatus","text":"Renderer . Component .NotificationStatus","title":"Enumeration: NotificationStatus"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#enumeration-members","text":"ERROR INFO OK","title":"Enumeration Members"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#enumeration-members_1","text":"","title":"Enumeration Members"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#error","text":"\u2022 ERROR = \"error\"","title":"ERROR"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#info","text":"\u2022 INFO = \"info\"","title":"INFO"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#ok","text":"\u2022 OK = \"ok\"","title":"OK"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/","text":"Enumeration: TooltipPosition # Renderer . Component .TooltipPosition Table of contents # Enumeration Members # BOTTOM BOTTOM_LEFT BOTTOM_RIGHT LEFT RIGHT TOP TOP_LEFT TOP_RIGHT Enumeration Members # BOTTOM # \u2022 BOTTOM = \"bottom\" BOTTOM_LEFT # \u2022 BOTTOM_LEFT = \"bottom_left\" BOTTOM_RIGHT # \u2022 BOTTOM_RIGHT = \"bottom_right\" LEFT # \u2022 LEFT = \"left\" RIGHT # \u2022 RIGHT = \"right\" TOP # \u2022 TOP = \"top\" TOP_LEFT # \u2022 TOP_LEFT = \"top_left\" TOP_RIGHT # \u2022 TOP_RIGHT = \"top_right\"","title":"Enumeration: TooltipPosition"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#enumeration-tooltipposition","text":"Renderer . Component .TooltipPosition","title":"Enumeration: TooltipPosition"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#enumeration-members","text":"BOTTOM BOTTOM_LEFT BOTTOM_RIGHT LEFT RIGHT TOP TOP_LEFT TOP_RIGHT","title":"Enumeration Members"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#enumeration-members_1","text":"","title":"Enumeration Members"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#bottom","text":"\u2022 BOTTOM = \"bottom\"","title":"BOTTOM"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#bottom_left","text":"\u2022 BOTTOM_LEFT = \"bottom_left\"","title":"BOTTOM_LEFT"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#bottom_right","text":"\u2022 BOTTOM_RIGHT = \"bottom_right\"","title":"BOTTOM_RIGHT"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#left","text":"\u2022 LEFT = \"left\"","title":"LEFT"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#right","text":"\u2022 RIGHT = \"right\"","title":"RIGHT"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#top","text":"\u2022 TOP = \"top\"","title":"TOP"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#top_left","text":"\u2022 TOP_LEFT = \"top_left\"","title":"TOP_LEFT"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#top_right","text":"\u2022 TOP_RIGHT = \"top_right\"","title":"TOP_RIGHT"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/","text":"Enumeration: KubeObjectStatusLevel # Renderer . K8sApi .KubeObjectStatusLevel Table of contents # Enumeration Members # CRITICAL INFO WARNING Enumeration Members # CRITICAL # \u2022 CRITICAL = 3 INFO # \u2022 INFO = 1 WARNING # \u2022 WARNING = 2","title":"Enumeration: KubeObjectStatusLevel"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#enumeration-kubeobjectstatuslevel","text":"Renderer . K8sApi .KubeObjectStatusLevel","title":"Enumeration: KubeObjectStatusLevel"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#enumeration-members","text":"CRITICAL INFO WARNING","title":"Enumeration Members"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#enumeration-members_1","text":"","title":"Enumeration Members"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#critical","text":"\u2022 CRITICAL = 3","title":"CRITICAL"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#info","text":"\u2022 INFO = 1","title":"INFO"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#warning","text":"\u2022 WARNING = 2","title":"WARNING"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/","text":"Interface: CatalogCategoryEvents # Common . Catalog .CatalogCategoryEvents Table of contents # Properties # catalogAddMenu contextMenuOpen load Properties # catalogAddMenu # \u2022 catalogAddMenu : ( context : CatalogEntityAddMenuContext ) => void Type declaration # \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. Parameters # Name Type context CatalogEntityAddMenuContext Returns # void contextMenuOpen # \u2022 contextMenuOpen : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >, context : CatalogEntityContextMenuContext ) => void Type declaration # \u25b8 ( entity , context ): void This event will be emitted when the context menu for an entity is declared by this category is opened. Parameters # Name Type entity CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > context CatalogEntityContextMenuContext Returns # void load # \u2022 load : () => void Type declaration # \u25b8 (): void This event will be emitted when the category is loaded in the catalog view. Returns # void","title":"Interface: CatalogCategoryEvents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#interface-catalogcategoryevents","text":"Common . Catalog .CatalogCategoryEvents","title":"Interface: CatalogCategoryEvents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#properties","text":"catalogAddMenu contextMenuOpen load","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#catalogaddmenu","text":"\u2022 catalogAddMenu : ( context : CatalogEntityAddMenuContext ) => void","title":"catalogAddMenu"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#contextmenuopen","text":"\u2022 contextMenuOpen : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >, context : CatalogEntityContextMenuContext ) => void","title":"contextMenuOpen"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#load","text":"\u2022 load : () => void","title":"load"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/","text":"Interface: CatalogCategoryMetadata # Common . Catalog .CatalogCategoryMetadata Table of contents # Properties # icon name Properties # icon # \u2022 Readonly icon : string Either an or the name of an icon from IconProps name # \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.","title":"Interface: CatalogCategoryMetadata"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#interface-catalogcategorymetadata","text":"Common . Catalog .CatalogCategoryMetadata","title":"Interface: CatalogCategoryMetadata"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#properties","text":"icon name","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#icon","text":"\u2022 Readonly icon : string Either an or the name of an icon from IconProps","title":"icon"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#name","text":"\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.","title":"name"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/","text":"Interface: CatalogCategorySpec # Common . Catalog .CatalogCategorySpec Table of contents # Properties # displayColumns group names versions Properties # displayColumns # \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. group # \u2022 Readonly group : string The grouping for for the category. This MUST be a DNS label. names # \u2022 Readonly names : Object This is the concerning the category Type declaration # Name Type Description kind 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. versions # \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","title":"Interface: CatalogCategorySpec"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#interface-catalogcategoryspec","text":"Common . Catalog .CatalogCategorySpec","title":"Interface: CatalogCategorySpec"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#properties","text":"displayColumns group names versions","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#displaycolumns","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.","title":"displayColumns"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#group","text":"\u2022 Readonly group : string The grouping for for the category. This MUST be a DNS label.","title":"group"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#names","text":"\u2022 Readonly names : Object This is the concerning the category","title":"names"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#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","title":"versions"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/","text":"Interface: CatalogCategoryVersion # Common . Catalog .CatalogCategoryVersion Table of contents # Properties # entityClass name Properties # entityClass # \u2022 Readonly entityClass : CatalogEntityConstructor < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >> The constructor for the entities. name # \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","title":"Interface: CatalogCategoryVersion"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#interface-catalogcategoryversion","text":"Common . Catalog .CatalogCategoryVersion","title":"Interface: CatalogCategoryVersion"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#properties","text":"entityClass name","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#entityclass","text":"\u2022 Readonly entityClass : CatalogEntityConstructor < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >> The constructor for the entities.","title":"entityClass"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#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","title":"name"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/","text":"Interface: CatalogEntityActionContext # Common . Catalog .CatalogEntityActionContext Table of contents # Properties # navigate setCommandPaletteContext Properties # navigate # \u2022 navigate : ( url : string ) => void Type declaration # \u25b8 ( url ): void Parameters # Name Type url string Returns # void setCommandPaletteContext # \u2022 setCommandPaletteContext : ( context? : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => void Type declaration # \u25b8 ( context? ): void Parameters # Name Type context? CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Returns # void","title":"Interface: CatalogEntityActionContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#interface-catalogentityactioncontext","text":"Common . Catalog .CatalogEntityActionContext","title":"Interface: CatalogEntityActionContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#properties","text":"navigate setCommandPaletteContext","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#navigate","text":"\u2022 navigate : ( url : string ) => void","title":"navigate"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#setcommandpalettecontext","text":"\u2022 setCommandPaletteContext : ( context? : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => void","title":"setCommandPaletteContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/","text":"Interface: CatalogEntityAddMenu # Common . Catalog .CatalogEntityAddMenu Hierarchy # CatalogEntityContextMenu \u21b3 CatalogEntityAddMenu Table of contents # Properties # confirm defaultAction icon onClick title Properties # confirm # \u2022 Optional confirm : Object Confirm click with a message Type declaration # Name Type message string Inherited from # CatalogEntityContextMenu . confirm defaultAction # \u2022 Optional defaultAction : boolean icon # \u2022 icon : string Menu icon Overrides # CatalogEntityContextMenu . icon onClick # \u2022 onClick : () => void | Promise < void > Type declaration # \u25b8 (): void | Promise < void > OnClick handler Returns # void | Promise < void > Inherited from # CatalogEntityContextMenu . onClick title # \u2022 title : string Menu title Inherited from # CatalogEntityContextMenu . title","title":"Interface: CatalogEntityAddMenu"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#interface-catalogentityaddmenu","text":"Common . Catalog .CatalogEntityAddMenu","title":"Interface: CatalogEntityAddMenu"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#hierarchy","text":"CatalogEntityContextMenu \u21b3 CatalogEntityAddMenu","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#properties","text":"confirm defaultAction icon onClick title","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#confirm","text":"\u2022 Optional confirm : Object Confirm click with a message","title":"confirm"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#defaultaction","text":"\u2022 Optional defaultAction : boolean","title":"defaultAction"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#icon","text":"\u2022 icon : string Menu icon","title":"icon"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#onclick","text":"\u2022 onClick : () => void | Promise < void >","title":"onClick"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#title","text":"\u2022 title : string Menu title","title":"title"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/","text":"Interface: CatalogEntityAddMenuContext # Common . Catalog .CatalogEntityAddMenuContext Table of contents # Properties # menuItems navigate Properties # menuItems # \u2022 menuItems : CatalogEntityAddMenu [] navigate # \u2022 navigate : ( url : string ) => void Type declaration # \u25b8 ( url ): void Parameters # Name Type url string Returns # void","title":"Interface: CatalogEntityAddMenuContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#interface-catalogentityaddmenucontext","text":"Common . Catalog .CatalogEntityAddMenuContext","title":"Interface: CatalogEntityAddMenuContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#properties","text":"menuItems navigate","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#menuitems","text":"\u2022 menuItems : CatalogEntityAddMenu []","title":"menuItems"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#navigate","text":"\u2022 navigate : ( url : string ) => void","title":"navigate"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/","text":"Interface: CatalogEntityContextMenu # Common . Catalog .CatalogEntityContextMenu Hierarchy # CatalogEntityContextMenu \u21b3 CatalogEntityAddMenu Table of contents # Properties # confirm icon onClick title Properties # confirm # \u2022 Optional confirm : Object Confirm click with a message Type declaration # Name Type message string icon # \u2022 Optional icon : string Menu icon onClick # \u2022 onClick : () => void | Promise < void > Type declaration # \u25b8 (): void | Promise < void > OnClick handler Returns # void | Promise < void > title # \u2022 title : string Menu title","title":"Interface: CatalogEntityContextMenu"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#interface-catalogentitycontextmenu","text":"Common . Catalog .CatalogEntityContextMenu","title":"Interface: CatalogEntityContextMenu"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#hierarchy","text":"CatalogEntityContextMenu \u21b3 CatalogEntityAddMenu","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#properties","text":"confirm icon onClick title","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#confirm","text":"\u2022 Optional confirm : Object Confirm click with a message","title":"confirm"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#icon","text":"\u2022 Optional icon : string Menu icon","title":"icon"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#onclick","text":"\u2022 onClick : () => void | Promise < void >","title":"onClick"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#title","text":"\u2022 title : string Menu title","title":"title"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/","text":"Interface: CatalogEntityContextMenuContext # Common . Catalog .CatalogEntityContextMenuContext Table of contents # Properties # menuItems navigate Properties # menuItems # \u2022 menuItems : CatalogEntityContextMenu [] navigate # \u2022 navigate : CatalogEntityContextMenuNavigate Navigate to the specified pathname","title":"Interface: CatalogEntityContextMenuContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#interface-catalogentitycontextmenucontext","text":"Common . Catalog .CatalogEntityContextMenuContext","title":"Interface: CatalogEntityContextMenuContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#properties","text":"menuItems navigate","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#menuitems","text":"\u2022 menuItems : CatalogEntityContextMenu []","title":"menuItems"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#navigate","text":"\u2022 navigate : CatalogEntityContextMenuNavigate Navigate to the specified pathname","title":"navigate"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/","text":"Interface: CatalogEntityContextMenuNavigate # Common . Catalog .CatalogEntityContextMenuNavigate Callable # CatalogEntityContextMenuNavigate # \u25b8 CatalogEntityContextMenuNavigate ( pathname , forceMainFrame? ): void Parameters # Name Type Description pathname string The location to navigate to in the main iframe forceMainFrame? boolean - Returns # void CatalogEntityContextMenuNavigate # \u25b8 CatalogEntityContextMenuNavigate ( pathname , forceMainFrame ): void Parameters # Name Type Description pathname string The location to navigate to in the current iframe. Useful for when called within the cluster frame forceMainFrame false - Returns # void","title":"Interface: CatalogEntityContextMenuNavigate"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#interface-catalogentitycontextmenunavigate","text":"Common . Catalog .CatalogEntityContextMenuNavigate","title":"Interface: CatalogEntityContextMenuNavigate"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#callable","text":"","title":"Callable"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#catalogentitycontextmenunavigate","text":"\u25b8 CatalogEntityContextMenuNavigate ( pathname , forceMainFrame? ): void","title":"CatalogEntityContextMenuNavigate"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#catalogentitycontextmenunavigate_1","text":"\u25b8 CatalogEntityContextMenuNavigate ( pathname , forceMainFrame ): void","title":"CatalogEntityContextMenuNavigate"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/","text":"Interface: CatalogEntityData # Common . Catalog .CatalogEntityData Type parameters # Name Type Metadata extends CatalogEntityMetadata = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec Table of contents # Properties # metadata spec status Properties # metadata # \u2022 metadata : Metadata spec # \u2022 spec : Spec status # \u2022 status : Status","title":"Interface: CatalogEntityData"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#interface-catalogentitydatametadata-status-spec","text":"Common . Catalog .CatalogEntityData","title":"Interface: CatalogEntityData<Metadata, Status, Spec>"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#type-parameters","text":"Name Type Metadata extends CatalogEntityMetadata = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec","title":"Type parameters"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#properties","text":"metadata spec status","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#spec","text":"\u2022 spec : Spec","title":"spec"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#status","text":"\u2022 status : Status","title":"status"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/","text":"Interface: CatalogEntityKindData # Common . Catalog .CatalogEntityKindData Implemented by # CatalogEntity Table of contents # Properties # apiVersion kind Properties # apiVersion # \u2022 Readonly apiVersion : string kind # \u2022 Readonly kind : string","title":"Interface: CatalogEntityKindData"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#interface-catalogentitykinddata","text":"Common . Catalog .CatalogEntityKindData","title":"Interface: CatalogEntityKindData"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#implemented-by","text":"CatalogEntity","title":"Implemented by"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#properties","text":"apiVersion kind","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#apiversion","text":"\u2022 Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#kind","text":"\u2022 Readonly kind : string","title":"kind"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/","text":"Interface: CatalogEntityMetadata # Common . Catalog .CatalogEntityMetadata Hierarchy # EntityMetadataObject \u21b3 CatalogEntityMetadata \u21b3\u21b3 KubernetesClusterMetadata Table of contents # Properties # description labels name shortName source uid Properties # description # \u2022 Optional description : string labels # \u2022 labels : Record < string , string > name # \u2022 name : string shortName # \u2022 Optional shortName : string source # \u2022 Optional source : string uid # \u2022 uid : string","title":"Interface: CatalogEntityMetadata"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#interface-catalogentitymetadata","text":"Common . Catalog .CatalogEntityMetadata","title":"Interface: CatalogEntityMetadata"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#hierarchy","text":"EntityMetadataObject \u21b3 CatalogEntityMetadata \u21b3\u21b3 KubernetesClusterMetadata","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#properties","text":"description labels name shortName source uid","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#description","text":"\u2022 Optional description : string","title":"description"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#labels","text":"\u2022 labels : Record < string , string >","title":"labels"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#shortname","text":"\u2022 Optional shortName : string","title":"shortName"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#source","text":"\u2022 Optional source : string","title":"source"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#uid","text":"\u2022 uid : string","title":"uid"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/","text":"Interface: CatalogEntitySettingsContext # Common . Catalog .CatalogEntitySettingsContext Table of contents # Properties # menuItems Properties # menuItems # \u2022 menuItems : CatalogEntityContextMenu []","title":"Interface: CatalogEntitySettingsContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#interface-catalogentitysettingscontext","text":"Common . Catalog .CatalogEntitySettingsContext","title":"Interface: CatalogEntitySettingsContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#properties","text":"menuItems","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#menuitems","text":"\u2022 menuItems : CatalogEntityContextMenu []","title":"menuItems"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/","text":"Interface: CatalogEntitySettingsMenu # Common . Catalog .CatalogEntitySettingsMenu Table of contents # Properties # components group title Properties # components # \u2022 components : Object Type declaration # Name Type View ComponentType < any > group # \u2022 Optional group : string title # \u2022 title : string","title":"Interface: CatalogEntitySettingsMenu"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#interface-catalogentitysettingsmenu","text":"Common . Catalog .CatalogEntitySettingsMenu","title":"Interface: CatalogEntitySettingsMenu"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#properties","text":"components group title","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#components","text":"\u2022 components : Object","title":"components"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#group","text":"\u2022 Optional group : string","title":"group"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#title","text":"\u2022 title : string","title":"title"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/","text":"Interface: CatalogEntityStatus # Common . Catalog .CatalogEntityStatus Hierarchy # CatalogEntityStatus \u21b3 WebLinkStatus \u21b3 KubernetesClusterStatus Table of contents # Properties # active enabled message phase reason Properties # active # \u2022 Optional active : boolean enabled # \u2022 Optional enabled : boolean Default true message # \u2022 Optional message : string phase # \u2022 phase : string reason # \u2022 Optional reason : string","title":"Interface: CatalogEntityStatus"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#interface-catalogentitystatus","text":"Common . Catalog .CatalogEntityStatus","title":"Interface: CatalogEntityStatus"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#hierarchy","text":"CatalogEntityStatus \u21b3 WebLinkStatus \u21b3 KubernetesClusterStatus","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#properties","text":"active enabled message phase reason","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#enabled","text":"\u2022 Optional enabled : boolean Default true","title":"enabled"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#message","text":"\u2022 Optional message : string","title":"message"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#phase","text":"\u2022 phase : string","title":"phase"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#reason","text":"\u2022 Optional reason : string","title":"reason"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/","text":"Interface: CategoryColumnRegistration # Common . Catalog .CategoryColumnRegistration Hierarchy # CategoryColumnRegistration \u21b3 AdditionalCategoryColumnRegistration Table of contents # Properties # id priority renderCell searchFilter sortCallback titleProps Properties # id # \u2022 id : string This value MUST to be unique to your extension priority # \u2022 Optional priority : number The sorting order value. Default 50 renderCell # \u2022 renderCell : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => ReactNode Type declaration # \u25b8 ( entity ): ReactNode This function will be called to generate the cells (on demand) for the column Parameters # Name Type entity CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Returns # ReactNode searchFilter # \u2022 Optional searchFilter : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | string [] Type declaration # \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. Parameters # Name Type entity CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Returns # string | string [] sortCallback # \u2022 Optional sortCallback : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | number | ( string | number )[] Type declaration # \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. Parameters # Name Type entity CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Returns # string | number | ( string | number )[] titleProps # \u2022 titleProps : TitleCellProps This function will be used to generate the columns title cell.","title":"Interface: CategoryColumnRegistration"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#interface-categorycolumnregistration","text":"Common . Catalog .CategoryColumnRegistration","title":"Interface: CategoryColumnRegistration"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#hierarchy","text":"CategoryColumnRegistration \u21b3 AdditionalCategoryColumnRegistration","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#properties","text":"id priority renderCell searchFilter sortCallback titleProps","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#id","text":"\u2022 id : string This value MUST to be unique to your extension","title":"id"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#priority","text":"\u2022 Optional priority : number The sorting order value. Default 50","title":"priority"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#rendercell","text":"\u2022 renderCell : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => ReactNode","title":"renderCell"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#searchfilter","text":"\u2022 Optional searchFilter : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | string []","title":"searchFilter"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#sortcallback","text":"\u2022 Optional sortCallback : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | number | ( string | number )[]","title":"sortCallback"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#titleprops","text":"\u2022 titleProps : TitleCellProps This function will be used to generate the columns title cell.","title":"titleProps"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/","text":"Interface: GeneralEntitySpec # Common . Catalog .GeneralEntitySpec Hierarchy # CatalogEntitySpec \u21b3 GeneralEntitySpec Table of contents # Properties # icon path Properties # icon # \u2022 Optional icon : Object Type declaration # Name Type background? string material? string path # \u2022 path : string","title":"Interface: GeneralEntitySpec"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#interface-generalentityspec","text":"Common . Catalog .GeneralEntitySpec","title":"Interface: GeneralEntitySpec"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#hierarchy","text":"CatalogEntitySpec \u21b3 GeneralEntitySpec","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#properties","text":"icon path","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#icon","text":"\u2022 Optional icon : Object","title":"icon"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#path","text":"\u2022 path : string","title":"path"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/","text":"Interface: KubernetesClusterMetadata # Common . Catalog .KubernetesClusterMetadata Hierarchy # CatalogEntityMetadata \u21b3 KubernetesClusterMetadata Table of contents # Properties # description distro kubeVersion labels name shortName source uid Properties # description # \u2022 Optional description : string Inherited from # CatalogEntityMetadata . description distro # \u2022 Optional distro : string kubeVersion # \u2022 Optional kubeVersion : string labels # \u2022 labels : Record < string , string > Inherited from # CatalogEntityMetadata . labels name # \u2022 name : string Inherited from # CatalogEntityMetadata . name shortName # \u2022 Optional shortName : string Inherited from # CatalogEntityMetadata . shortName source # \u2022 Optional source : string Inherited from # CatalogEntityMetadata . source uid # \u2022 uid : string Inherited from # CatalogEntityMetadata . uid","title":"Interface: KubernetesClusterMetadata"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#interface-kubernetesclustermetadata","text":"Common . Catalog .KubernetesClusterMetadata","title":"Interface: KubernetesClusterMetadata"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#hierarchy","text":"CatalogEntityMetadata \u21b3 KubernetesClusterMetadata","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#properties","text":"description distro kubeVersion labels name shortName source uid","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#description","text":"\u2022 Optional description : string","title":"description"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#distro","text":"\u2022 Optional distro : string","title":"distro"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#kubeversion","text":"\u2022 Optional kubeVersion : string","title":"kubeVersion"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#labels","text":"\u2022 labels : Record < string , string >","title":"labels"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#shortname","text":"\u2022 Optional shortName : string","title":"shortName"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#source","text":"\u2022 Optional source : string","title":"source"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#uid","text":"\u2022 uid : string","title":"uid"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/","text":"Interface: KubernetesClusterPrometheusMetrics # Common . Catalog .KubernetesClusterPrometheusMetrics Table of contents # Properties # address type Properties # address # \u2022 Optional address : Object Type declaration # Name Type namespace string port number prefix string service string type # \u2022 Optional type : string","title":"Interface: KubernetesClusterPrometheusMetrics"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#interface-kubernetesclusterprometheusmetrics","text":"Common . Catalog .KubernetesClusterPrometheusMetrics","title":"Interface: KubernetesClusterPrometheusMetrics"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#properties","text":"address type","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#address","text":"\u2022 Optional address : Object","title":"address"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#type","text":"\u2022 Optional type : string","title":"type"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/","text":"Interface: KubernetesClusterSpec # Common . Catalog .KubernetesClusterSpec Hierarchy # CatalogEntitySpec \u21b3 KubernetesClusterSpec Table of contents # Properties # accessibleNamespaces icon kubeconfigContext kubeconfigPath metrics Properties # accessibleNamespaces # \u2022 Optional accessibleNamespaces : string [] icon # \u2022 Optional icon : Object Type declaration # Name Type background? string material? string src? string kubeconfigContext # \u2022 kubeconfigContext : string kubeconfigPath # \u2022 kubeconfigPath : string metrics # \u2022 Optional metrics : Object Type declaration # Name Type prometheus? KubernetesClusterPrometheusMetrics source string","title":"Interface: KubernetesClusterSpec"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#interface-kubernetesclusterspec","text":"Common . Catalog .KubernetesClusterSpec","title":"Interface: KubernetesClusterSpec"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#hierarchy","text":"CatalogEntitySpec \u21b3 KubernetesClusterSpec","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#properties","text":"accessibleNamespaces icon kubeconfigContext kubeconfigPath metrics","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#accessiblenamespaces","text":"\u2022 Optional accessibleNamespaces : string []","title":"accessibleNamespaces"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#icon","text":"\u2022 Optional icon : Object","title":"icon"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#kubeconfigcontext","text":"\u2022 kubeconfigContext : string","title":"kubeconfigContext"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#kubeconfigpath","text":"\u2022 kubeconfigPath : string","title":"kubeconfigPath"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#metrics","text":"\u2022 Optional metrics : Object","title":"metrics"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/","text":"Interface: KubernetesClusterStatus # Common . Catalog .KubernetesClusterStatus Hierarchy # CatalogEntityStatus \u21b3 KubernetesClusterStatus Table of contents # Properties # active enabled message phase reason Properties # active # \u2022 Optional active : boolean Inherited from # CatalogEntityStatus . active enabled # \u2022 Optional enabled : boolean Default true Inherited from # CatalogEntityStatus . enabled message # \u2022 Optional message : string Inherited from # CatalogEntityStatus . message phase # \u2022 phase : string Inherited from # CatalogEntityStatus . phase reason # \u2022 Optional reason : string Inherited from # CatalogEntityStatus . reason","title":"Interface: KubernetesClusterStatus"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#interface-kubernetesclusterstatus","text":"Common . Catalog .KubernetesClusterStatus","title":"Interface: KubernetesClusterStatus"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#hierarchy","text":"CatalogEntityStatus \u21b3 KubernetesClusterStatus","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#properties","text":"active enabled message phase reason","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#enabled","text":"\u2022 Optional enabled : boolean Default true","title":"enabled"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#message","text":"\u2022 Optional message : string","title":"message"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#phase","text":"\u2022 phase : string","title":"phase"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#reason","text":"\u2022 Optional reason : string","title":"reason"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/","text":"Interface: TitleCellProps # Common . Catalog .TitleCellProps These are the supported props for the title cell Table of contents # Properties # className title Properties # className # \u2022 Optional className : string title # \u2022 title : string","title":"Interface: TitleCellProps"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#interface-titlecellprops","text":"Common . Catalog .TitleCellProps These are the supported props for the title cell","title":"Interface: TitleCellProps"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#properties","text":"className title","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#title","text":"\u2022 title : string","title":"title"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/","text":"Interface: WebLinkSpec # Common . Catalog .WebLinkSpec Table of contents # Properties # url Properties # url # \u2022 url : string","title":"Interface: WebLinkSpec"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#interface-weblinkspec","text":"Common . Catalog .WebLinkSpec","title":"Interface: WebLinkSpec"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#properties","text":"url","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#url","text":"\u2022 url : string","title":"url"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/","text":"Interface: WebLinkStatus # Common . Catalog .WebLinkStatus Hierarchy # CatalogEntityStatus \u21b3 WebLinkStatus Table of contents # Properties # active enabled message phase reason Properties # active # \u2022 Optional active : boolean Inherited from # CatalogEntityStatus . active enabled # \u2022 Optional enabled : boolean Default true Inherited from # CatalogEntityStatus . enabled message # \u2022 Optional message : string Inherited from # CatalogEntityStatus . message phase # \u2022 phase : WebLinkStatusPhase Overrides # CatalogEntityStatus . phase reason # \u2022 Optional reason : string Inherited from # CatalogEntityStatus . reason","title":"Interface: WebLinkStatus"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#interface-weblinkstatus","text":"Common . Catalog .WebLinkStatus","title":"Interface: WebLinkStatus"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#hierarchy","text":"CatalogEntityStatus \u21b3 WebLinkStatus","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#properties","text":"active enabled message phase reason","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#enabled","text":"\u2022 Optional enabled : boolean Default true","title":"enabled"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#message","text":"\u2022 Optional message : string","title":"message"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#phase","text":"\u2022 phase : WebLinkStatusPhase","title":"phase"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#reason","text":"\u2022 Optional reason : string","title":"reason"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/","text":"Interface: AppEvent # Common . EventBus .AppEvent Data for telemetry Table of contents # Properties # action destination name params Properties # action # \u2022 action : string destination # \u2022 Optional destination : string name # \u2022 name : string params # \u2022 Optional params : Record < string , any >","title":"Interface: AppEvent"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#interface-appevent","text":"Common . EventBus .AppEvent Data for telemetry","title":"Interface: AppEvent"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#properties","text":"action destination name params","title":"Properties"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#action","text":"\u2022 action : string","title":"action"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#destination","text":"\u2022 Optional destination : string","title":"destination"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#params","text":"\u2022 Optional params : Record < string , any >","title":"params"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/","text":"Interface: EventEmitterOptions # Common . EventBus .EventEmitterOptions Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Table of contents # Properties # once prepend Properties # once # \u2022 Optional once : boolean prepend # \u2022 Optional prepend : boolean","title":"Interface: EventEmitterOptions"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#interface-eventemitteroptions","text":"Common . EventBus .EventEmitterOptions Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"Interface: EventEmitterOptions"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#properties","text":"once prepend","title":"Properties"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#once","text":"\u2022 Optional once : boolean","title":"once"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#prepend","text":"\u2022 Optional prepend : boolean","title":"prepend"},{"location":"extensions/api/interfaces/Common.InstalledExtension/","text":"Interface: InstalledExtension # Common .InstalledExtension Table of contents # Properties # absolutePath id isBundled isCompatible isEnabled manifest manifestPath Properties # absolutePath # \u2022 Readonly absolutePath : string id # \u2022 id : string isBundled # \u2022 Readonly isBundled : boolean isCompatible # \u2022 Readonly isCompatible : boolean isEnabled # \u2022 isEnabled : boolean manifest # \u2022 Readonly manifest : LensExtensionManifest manifestPath # \u2022 Readonly manifestPath : string","title":"Interface: InstalledExtension"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#interface-installedextension","text":"Common .InstalledExtension","title":"Interface: InstalledExtension"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#properties","text":"absolutePath id isBundled isCompatible isEnabled manifest manifestPath","title":"Properties"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#absolutepath","text":"\u2022 Readonly absolutePath : string","title":"absolutePath"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#id","text":"\u2022 id : string","title":"id"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#isbundled","text":"\u2022 Readonly isBundled : boolean","title":"isBundled"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#iscompatible","text":"\u2022 Readonly isCompatible : boolean","title":"isCompatible"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#isenabled","text":"\u2022 isEnabled : boolean","title":"isEnabled"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#manifest","text":"\u2022 Readonly manifest : LensExtensionManifest","title":"manifest"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#manifestpath","text":"\u2022 Readonly manifestPath : string","title":"manifestPath"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/","text":"Interface: LensExtensionManifest # Common .LensExtensionManifest Hierarchy # PackageJson \u21b3 LensExtensionManifest Table of contents # Properties # engines main name renderer storeName version Properties # engines # \u2022 engines : Object Supported Lens version engine by extension could be defined in manifest.engines.lens Only MAJOR.MINOR version is taken in consideration. Type declaration # Name Type lens string node? string npm? string Overrides # PackageJson.engines main # \u2022 Optional main : string Overrides # PackageJson.main name # \u2022 name : string Overrides # PackageJson.name renderer # \u2022 Optional renderer : string storeName # \u2022 Optional storeName : string version # \u2022 version : string Overrides # PackageJson.version","title":"Interface: LensExtensionManifest"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#interface-lensextensionmanifest","text":"Common .LensExtensionManifest","title":"Interface: LensExtensionManifest"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#hierarchy","text":"PackageJson \u21b3 LensExtensionManifest","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#properties","text":"engines main name renderer storeName version","title":"Properties"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#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.","title":"engines"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#main","text":"\u2022 Optional main : string","title":"main"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#renderer","text":"\u2022 Optional renderer : string","title":"renderer"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#storename","text":"\u2022 Optional storeName : string","title":"storeName"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#version","text":"\u2022 version : string","title":"version"},{"location":"extensions/api/interfaces/Common.Logger/","text":"Interface: Logger # Common .Logger Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Table of contents # Properties # debug error info silly warn Properties # debug # \u2022 debug : ( message : string , ... args : any ) => void Type declaration # \u25b8 ( message , ...args ): void Parameters # Name Type message string ...args any Returns # void error # \u2022 error : ( message : string , ... args : any ) => void Type declaration # \u25b8 ( message , ...args ): void Parameters # Name Type message string ...args any Returns # void info # \u2022 info : ( message : string , ... args : any ) => void Type declaration # \u25b8 ( message , ...args ): void Parameters # Name Type message string ...args any Returns # void silly # \u2022 silly : ( message : string , ... args : any ) => void Type declaration # \u25b8 ( message , ...args ): void Parameters # Name Type message string ...args any Returns # void warn # \u2022 warn : ( message : string , ... args : any ) => void Type declaration # \u25b8 ( message , ...args ): void Parameters # Name Type message string ...args any Returns # void","title":"Interface: Logger"},{"location":"extensions/api/interfaces/Common.Logger/#interface-logger","text":"Common .Logger Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"Interface: Logger"},{"location":"extensions/api/interfaces/Common.Logger/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Logger/#properties","text":"debug error info silly warn","title":"Properties"},{"location":"extensions/api/interfaces/Common.Logger/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Logger/#debug","text":"\u2022 debug : ( message : string , ... args : any ) => void","title":"debug"},{"location":"extensions/api/interfaces/Common.Logger/#error","text":"\u2022 error : ( message : string , ... args : any ) => void","title":"error"},{"location":"extensions/api/interfaces/Common.Logger/#info","text":"\u2022 info : ( message : string , ... args : any ) => void","title":"info"},{"location":"extensions/api/interfaces/Common.Logger/#silly","text":"\u2022 silly : ( message : string , ... args : any ) => void","title":"silly"},{"location":"extensions/api/interfaces/Common.Logger/#warn","text":"\u2022 warn : ( message : string , ... args : any ) => void","title":"warn"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/","text":"Interface: BaseStoreParams # Common . Store .BaseStoreParams Type parameters # Name T Hierarchy # Omit < ConfOptions < T >, \"migrations\" > \u21b3 BaseStoreParams Table of contents # Properties # configName syncOptions Properties # configName # \u2022 configName : string Overrides # Omit.configName syncOptions # \u2022 Optional syncOptions : Object Type declaration # Name Type equals? IEqualsComparer < T > fireImmediately? boolean","title":"Interface: BaseStoreParams"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#interface-basestoreparamst","text":"Common . Store .BaseStoreParams","title":"Interface: BaseStoreParams<T>"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#type-parameters","text":"Name T","title":"Type parameters"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#hierarchy","text":"Omit < ConfOptions < T >, \"migrations\" > \u21b3 BaseStoreParams","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#properties","text":"configName syncOptions","title":"Properties"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#configname","text":"\u2022 configName : string","title":"configName"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#syncoptions","text":"\u2022 Optional syncOptions : Object","title":"syncOptions"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/","text":"Interface: AppPreferenceComponents # Common . Types .AppPreferenceComponents Table of contents # Properties # Hint Input Properties # Hint # \u2022 Hint : ComponentType < any > Input # \u2022 Input : ComponentType < any >","title":"Interface: AppPreferenceComponents"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#interface-apppreferencecomponents","text":"Common . Types .AppPreferenceComponents","title":"Interface: AppPreferenceComponents"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#properties","text":"Hint Input","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#hint","text":"\u2022 Hint : ComponentType < any >","title":"Hint"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#input","text":"\u2022 Input : ComponentType < any >","title":"Input"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/","text":"Interface: AppPreferenceRegistration # Common . Types .AppPreferenceRegistration Table of contents # Properties # components id showInPreferencesTab title Properties # components # \u2022 components : AppPreferenceComponents id # \u2022 Optional id : string showInPreferencesTab # \u2022 Optional showInPreferencesTab : string title # \u2022 title : string","title":"Interface: AppPreferenceRegistration"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#interface-apppreferenceregistration","text":"Common . Types .AppPreferenceRegistration","title":"Interface: AppPreferenceRegistration"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#properties","text":"components id showInPreferencesTab title","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#components","text":"\u2022 components : AppPreferenceComponents","title":"components"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#showinpreferencestab","text":"\u2022 Optional showInPreferencesTab : string","title":"showInPreferencesTab"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#title","text":"\u2022 title : string","title":"title"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/","text":"Interface: ClusterPageMenuComponents # Common . Types .ClusterPageMenuComponents Table of contents # Properties # Icon Properties # Icon # \u2022 Icon : ComponentType < IconProps >","title":"Interface: ClusterPageMenuComponents"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#interface-clusterpagemenucomponents","text":"Common . Types .ClusterPageMenuComponents","title":"Interface: ClusterPageMenuComponents"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#properties","text":"Icon","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#icon","text":"\u2022 Icon : ComponentType < IconProps >","title":"Icon"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/","text":"Interface: ClusterPageMenuRegistration # Common . Types .ClusterPageMenuRegistration Table of contents # Properties # components id orderNumber parentId target title visible Properties # components # \u2022 components : ClusterPageMenuComponents id # \u2022 Optional id : string orderNumber # \u2022 Optional orderNumber : number parentId # \u2022 Optional parentId : string target # \u2022 Optional target : PageTarget title # \u2022 title : ReactNode visible # \u2022 Optional visible : IComputedValue < boolean >","title":"Interface: ClusterPageMenuRegistration"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#interface-clusterpagemenuregistration","text":"Common . Types .ClusterPageMenuRegistration","title":"Interface: ClusterPageMenuRegistration"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#properties","text":"components id orderNumber parentId target title visible","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#components","text":"\u2022 components : ClusterPageMenuComponents","title":"components"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#ordernumber","text":"\u2022 Optional orderNumber : number","title":"orderNumber"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#parentid","text":"\u2022 Optional parentId : string","title":"parentId"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#target","text":"\u2022 Optional target : PageTarget","title":"target"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#title","text":"\u2022 title : ReactNode","title":"title"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#visible","text":"\u2022 Optional visible : IComputedValue < boolean >","title":"visible"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/","text":"Interface: CustomCategoryViewComponents # Common . Types .CustomCategoryViewComponents The components for the category view. Table of contents # Properties # View Properties # View # \u2022 View : ComponentType < CustomCategoryViewProps >","title":"Interface: CustomCategoryViewComponents"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#interface-customcategoryviewcomponents","text":"Common . Types .CustomCategoryViewComponents The components for the category view.","title":"Interface: CustomCategoryViewComponents"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#properties","text":"View","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#view","text":"\u2022 View : ComponentType < CustomCategoryViewProps >","title":"View"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/","text":"Interface: CustomCategoryViewProps # Common . Types .CustomCategoryViewProps The props for CustomCategoryViewComponents.View Table of contents # Properties # category Properties # category # \u2022 category : CatalogCategory The category instance itself","title":"Interface: CustomCategoryViewProps"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#interface-customcategoryviewprops","text":"Common . Types .CustomCategoryViewProps The props for CustomCategoryViewComponents.View","title":"Interface: CustomCategoryViewProps"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#properties","text":"category","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#category","text":"\u2022 category : CatalogCategory The category instance itself","title":"category"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/","text":"Interface: CustomCategoryViewRegistration # Common . Types .CustomCategoryViewRegistration This is the type used to declare additional views for a specific category Table of contents # Properties # components group kind priority Properties # components # \u2022 components : CustomCategoryViewComponents The components for this registration group # \u2022 group : string The catalog entity group that is declared by the category for this registration e.g. - \"entity.k8slens.dev\" kind # \u2022 kind : string The catalog entity kind that is declared by the category for this registration e.g. - \"KubernetesCluster\" priority # \u2022 Optional priority : number The sorting order value. Used to determine the total order of the views. Default 50","title":"Interface: CustomCategoryViewRegistration"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#interface-customcategoryviewregistration","text":"Common . Types .CustomCategoryViewRegistration This is the type used to declare additional views for a specific category","title":"Interface: CustomCategoryViewRegistration"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#properties","text":"components group kind priority","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#components","text":"\u2022 components : CustomCategoryViewComponents The components for this registration","title":"components"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#group","text":"\u2022 group : string The catalog entity group that is declared by the category for this registration e.g. - \"entity.k8slens.dev\"","title":"group"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#kind","text":"\u2022 kind : string The catalog entity kind that is declared by the category for this registration e.g. - \"KubernetesCluster\"","title":"kind"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#priority","text":"\u2022 Optional priority : number The sorting order value. Used to determine the total order of the views. Default 50","title":"priority"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/","text":"Interface: KubeObjectContextMenuItem # Common . Types .KubeObjectContextMenuItem Table of contents # Properties # icon onClick title Properties # icon # \u2022 icon : string | BaseIconProps If the type is string then it is shorthand for BaseIconProps.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. onClick # \u2022 onClick : ( obj : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >) => void Type declaration # \u25b8 ( obj ): void The action when clicked Parameters # Name Type obj KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # void title # \u2022 title : string The title text for the menu item or the hover text for the icon.","title":"Interface: KubeObjectContextMenuItem"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#interface-kubeobjectcontextmenuitem","text":"Common . Types .KubeObjectContextMenuItem","title":"Interface: KubeObjectContextMenuItem"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#properties","text":"icon onClick title","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#icon","text":"\u2022 icon : string | BaseIconProps If the type is string then it is shorthand for BaseIconProps.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.","title":"icon"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#onclick","text":"\u2022 onClick : ( obj : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >) => void","title":"onClick"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#title","text":"\u2022 title : string The title text for the menu item or the hover text for the icon.","title":"title"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/","text":"Interface: KubeObjectDetailComponents # Common . Types .KubeObjectDetailComponents Type parameters # Name Type T extends KubeObject = KubeObject Table of contents # Properties # Details Properties # Details # \u2022 Details : ComponentType < KubeObjectDetailsProps < T >>","title":"Interface: KubeObjectDetailComponents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#interface-kubeobjectdetailcomponentst","text":"Common . Types .KubeObjectDetailComponents","title":"Interface: KubeObjectDetailComponents<T>"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#type-parameters","text":"Name Type T extends KubeObject = KubeObject","title":"Type parameters"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#properties","text":"Details","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#details","text":"\u2022 Details : ComponentType < KubeObjectDetailsProps < T >>","title":"Details"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/","text":"Interface: KubeObjectDetailRegistration # Common . Types .KubeObjectDetailRegistration Type parameters # Name Type T extends KubeObject = KubeObject Table of contents # Properties # apiVersions components kind priority visible Properties # apiVersions # \u2022 apiVersions : string [] components # \u2022 components : KubeObjectDetailComponents < T > kind # \u2022 kind : string priority # \u2022 Optional priority : number visible # \u2022 Optional visible : IComputedValue < boolean >","title":"Interface: KubeObjectDetailRegistration"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#interface-kubeobjectdetailregistrationt","text":"Common . Types .KubeObjectDetailRegistration","title":"Interface: KubeObjectDetailRegistration<T>"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#type-parameters","text":"Name Type T extends KubeObject = KubeObject","title":"Type parameters"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#properties","text":"apiVersions components kind priority visible","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#apiversions","text":"\u2022 apiVersions : string []","title":"apiVersions"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#components","text":"\u2022 components : KubeObjectDetailComponents < T >","title":"components"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#priority","text":"\u2022 Optional priority : number","title":"priority"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#visible","text":"\u2022 Optional visible : IComputedValue < boolean >","title":"visible"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/","text":"Interface: KubeObjectHandlers # Common . Types .KubeObjectHandlers Table of contents # Properties # onContextMenuOpen Properties # onContextMenuOpen # \u2022 onContextMenuOpen : KubeObjectOnContextMenuOpen","title":"Interface: KubeObjectHandlers"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#interface-kubeobjecthandlers","text":"Common . Types .KubeObjectHandlers","title":"Interface: KubeObjectHandlers"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#properties","text":"onContextMenuOpen","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#oncontextmenuopen","text":"\u2022 onContextMenuOpen : KubeObjectOnContextMenuOpen","title":"onContextMenuOpen"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/","text":"Interface: KubeObjectMenuComponents # Common . Types .KubeObjectMenuComponents Table of contents # Properties # MenuItem Properties # MenuItem # \u2022 MenuItem : ComponentType < KubeObjectMenuItemProps >","title":"Interface: KubeObjectMenuComponents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#interface-kubeobjectmenucomponents","text":"Common . Types .KubeObjectMenuComponents","title":"Interface: KubeObjectMenuComponents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#properties","text":"MenuItem","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#menuitem","text":"\u2022 MenuItem : ComponentType < KubeObjectMenuItemProps >","title":"MenuItem"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/","text":"Interface: KubeObjectMenuRegistration # Common . Types .KubeObjectMenuRegistration Table of contents # Properties # apiVersions components kind visible Properties # apiVersions # \u2022 apiVersions : string [] components # \u2022 components : KubeObjectMenuComponents kind # \u2022 kind : string visible # \u2022 Optional visible : IComputedValue < boolean >","title":"Interface: KubeObjectMenuRegistration"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#interface-kubeobjectmenuregistration","text":"Common . Types .KubeObjectMenuRegistration","title":"Interface: KubeObjectMenuRegistration"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#properties","text":"apiVersions components kind visible","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#apiversions","text":"\u2022 apiVersions : string []","title":"apiVersions"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#components","text":"\u2022 components : KubeObjectMenuComponents","title":"components"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#visible","text":"\u2022 Optional visible : IComputedValue < boolean >","title":"visible"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/","text":"Interface: KubeObjectOnContextMenuOpenContext # Common . Types .KubeObjectOnContextMenuOpenContext Table of contents # Properties # menuItems navigate Properties # menuItems # \u2022 menuItems : KubeObjectContextMenuItem [] navigate # \u2022 navigate : ( location : string ) => void Type declaration # \u25b8 ( location ): void Parameters # Name Type location string Returns # void","title":"Interface: KubeObjectOnContextMenuOpenContext"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#interface-kubeobjectoncontextmenuopencontext","text":"Common . Types .KubeObjectOnContextMenuOpenContext","title":"Interface: KubeObjectOnContextMenuOpenContext"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#properties","text":"menuItems navigate","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#menuitems","text":"\u2022 menuItems : KubeObjectContextMenuItem []","title":"menuItems"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#navigate","text":"\u2022 navigate : ( location : string ) => void","title":"navigate"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/","text":"Interface: KubeObjectStatusRegistration # Common . Types .KubeObjectStatusRegistration Table of contents # Properties # apiVersions kind resolve visible Properties # apiVersions # \u2022 apiVersions : string [] kind # \u2022 kind : string resolve # \u2022 resolve : ( object : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >) => KubeObjectStatus Type declaration # \u25b8 ( object ): KubeObjectStatus Parameters # Name Type object KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # KubeObjectStatus visible # \u2022 Optional visible : IComputedValue < boolean >","title":"Interface: KubeObjectStatusRegistration"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#interface-kubeobjectstatusregistration","text":"Common . Types .KubeObjectStatusRegistration","title":"Interface: KubeObjectStatusRegistration"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#properties","text":"apiVersions kind resolve visible","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#apiversions","text":"\u2022 apiVersions : string []","title":"apiVersions"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#resolve","text":"\u2022 resolve : ( object : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >) => KubeObjectStatus","title":"resolve"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#visible","text":"\u2022 Optional visible : IComputedValue < boolean >","title":"visible"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/","text":"Interface: PageComponentProps

    # Common . Types .PageComponentProps Type parameters # Name Type P extends PageParams = {} Table of contents # Properties # params Properties # params # \u2022 Optional params : { [N in string | number | symbol]: PageParam }","title":"Interface: PageComponentProps"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#interface-pagecomponentpropsp","text":"Common . Types .PageComponentProps","title":"Interface: PageComponentProps<P>"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#type-parameters","text":"Name Type P extends PageParams = {}","title":"Type parameters"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#properties","text":"params","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#params","text":"\u2022 Optional params : { [N in string | number | symbol]: PageParam }","title":"params"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/","text":"Interface: PageComponents # Common . Types .PageComponents Table of contents # Properties # Page Properties # Page # \u2022 Page : ComponentType < any >","title":"Interface: PageComponents"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#interface-pagecomponents","text":"Common . Types .PageComponents","title":"Interface: PageComponents"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#properties","text":"Page","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#page","text":"\u2022 Page : ComponentType < any >","title":"Page"},{"location":"extensions/api/interfaces/Common.Types.PageParams/","text":"Interface: PageParams # Common . Types .PageParams Type parameters # Name Type V any Indexable # \u25aa [paramName: string ]: V","title":"Interface: PageParams"},{"location":"extensions/api/interfaces/Common.Types.PageParams/#interface-pageparamsv","text":"Common . Types .PageParams","title":"Interface: PageParams<V>"},{"location":"extensions/api/interfaces/Common.Types.PageParams/#type-parameters","text":"Name Type V any","title":"Type parameters"},{"location":"extensions/api/interfaces/Common.Types.PageParams/#indexable","text":"\u25aa [paramName: string ]: V","title":"Indexable"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/","text":"Interface: PageRegistration # Common . Types .PageRegistration Table of contents # Properties # components enabled id params Properties # components # \u2022 components : PageComponents enabled # \u2022 Optional enabled : IComputedValue < boolean > id # \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 params # \u2022 Optional params : PageParams < string | Omit < PageParamInit < any >, \"name\" | \"prefix\" >>","title":"Interface: PageRegistration"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#interface-pageregistration","text":"Common . Types .PageRegistration","title":"Interface: PageRegistration"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#properties","text":"components enabled id params","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#components","text":"\u2022 components : PageComponents","title":"components"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#enabled","text":"\u2022 Optional enabled : IComputedValue < boolean >","title":"enabled"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#id","text":"\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","title":"id"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#params","text":"\u2022 Optional params : PageParams < string | Omit < PageParamInit < any >, \"name\" | \"prefix\" >>","title":"params"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/","text":"Interface: PageTarget # Common . Types .PageTarget Table of contents # Properties # extensionId pageId params Properties # extensionId # \u2022 Optional extensionId : string pageId # \u2022 Optional pageId : string params # \u2022 Optional params : PageParams < any >","title":"Interface: PageTarget"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#interface-pagetarget","text":"Common . Types .PageTarget","title":"Interface: PageTarget"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#properties","text":"extensionId pageId params","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#extensionid","text":"\u2022 Optional extensionId : string","title":"extensionId"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#pageid","text":"\u2022 Optional pageId : string","title":"pageId"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#params","text":"\u2022 Optional params : PageParams < any >","title":"params"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/","text":"Interface: ProtocolHandlerRegistration # Common . Types .ProtocolHandlerRegistration ProtocolHandlerRegistration is the data required for an extension to register a handler to a specific path or dynamic path. Table of contents # Properties # handler pathSchema Properties # handler # \u2022 handler : ProtocolRouteHandler pathSchema # \u2022 pathSchema : string","title":"Interface: ProtocolHandlerRegistration"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#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.","title":"Interface: ProtocolHandlerRegistration"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#properties","text":"handler pathSchema","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#handler","text":"\u2022 handler : ProtocolRouteHandler","title":"handler"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#pathschema","text":"\u2022 pathSchema : string","title":"pathSchema"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/","text":"Interface: ProtocolRouteHandler # Common . Types .ProtocolRouteHandler Callable # ProtocolRouteHandler # \u25b8 ProtocolRouteHandler ( params ): void RouteHandler represents the function signature of the handler function for lens:// protocol routing. Parameters # Name Type params ProtocolRouteParams Returns # void","title":"Interface: ProtocolRouteHandler"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#interface-protocolroutehandler","text":"Common . Types .ProtocolRouteHandler","title":"Interface: ProtocolRouteHandler"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#callable","text":"","title":"Callable"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#protocolroutehandler","text":"\u25b8 ProtocolRouteHandler ( params ): void RouteHandler represents the function signature of the handler function for lens:// protocol routing.","title":"ProtocolRouteHandler"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/","text":"Interface: ProtocolRouteParams # Common . Types .ProtocolRouteParams The collection of the dynamic parts of a URI which initiated a lens:// protocol request Table of contents # Properties # pathname search tail Properties # pathname # \u2022 pathname : Record < string , undefined | string > the matching parts of the path. The dynamic parts of the URI path. search # \u2022 search : Record < string , undefined | string > the parts of the URI query string tail # \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\" .","title":"Interface: ProtocolRouteParams"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#interface-protocolrouteparams","text":"Common . Types .ProtocolRouteParams The collection of the dynamic parts of a URI which initiated a lens:// protocol request","title":"Interface: ProtocolRouteParams"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#properties","text":"pathname search tail","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#pathname","text":"\u2022 pathname : Record < string , undefined | string > the matching parts of the path. The dynamic parts of the URI path.","title":"pathname"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#search","text":"\u2022 search : Record < string , undefined | string > the parts of the URI query string","title":"search"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#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\" .","title":"tail"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/","text":"Interface: RegisteredPage # Common . Types .RegisteredPage Table of contents # Properties # components extensionId id params url Properties # components # \u2022 components : PageComponents extensionId # \u2022 extensionId : string id # \u2022 id : string params # \u2022 params : PageParams < PageParam < any >> url # \u2022 url : string","title":"Interface: RegisteredPage"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#interface-registeredpage","text":"Common . Types .RegisteredPage","title":"Interface: RegisteredPage"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#properties","text":"components extensionId id params url","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#components","text":"\u2022 components : PageComponents","title":"components"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#extensionid","text":"\u2022 extensionId : string","title":"extensionId"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#id","text":"\u2022 id : string","title":"id"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#params","text":"\u2022 params : PageParams < PageParam < any >>","title":"params"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#url","text":"\u2022 url : string","title":"url"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/","text":"Interface: ShellEnvContext # Common . Types .ShellEnvContext Table of contents # Properties # catalogEntity Properties # catalogEntity # \u2022 catalogEntity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >","title":"Interface: ShellEnvContext"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#interface-shellenvcontext","text":"Common . Types .ShellEnvContext","title":"Interface: ShellEnvContext"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#properties","text":"catalogEntity","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#catalogentity","text":"\u2022 catalogEntity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >","title":"catalogEntity"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/","text":"Interface: StatusBarRegistration # Common . Types .StatusBarRegistration The type for registering status bar items from the LensRendererExtension Table of contents # Properties # components item visible Properties # components # \u2022 Optional components : StatusBarComponents The newer API, allows for registering a component instead of a ReactNode item # \u2022 Optional item : ReactNode | () => ReactNode Deprecated use components instead visible # \u2022 Optional visible : IComputedValue < boolean > If specified, controls item visibility","title":"Interface: StatusBarRegistration"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#interface-statusbarregistration","text":"Common . Types .StatusBarRegistration The type for registering status bar items from the LensRendererExtension","title":"Interface: StatusBarRegistration"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#properties","text":"components item visible","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#components","text":"\u2022 Optional components : StatusBarComponents The newer API, allows for registering a component instead of a ReactNode","title":"components"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#item","text":"\u2022 Optional item : ReactNode | () => ReactNode Deprecated use components instead","title":"item"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#visible","text":"\u2022 Optional visible : IComputedValue < boolean > If specified, controls item visibility","title":"visible"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/","text":"Interface: TrayMenuRegistration # Common . Types .TrayMenuRegistration Table of contents # Properties # click enabled id label submenu toolTip type visible Properties # click # \u2022 Optional click : ( menuItem : TrayMenuRegistration ) => void Type declaration # \u25b8 ( menuItem ): void Parameters # Name Type menuItem TrayMenuRegistration Returns # void enabled # \u2022 Optional enabled : boolean | IComputedValue < boolean > id # \u2022 Optional id : string label # \u2022 Optional label : string | IComputedValue < string > submenu # \u2022 Optional submenu : TrayMenuRegistration [] toolTip # \u2022 Optional toolTip : string type # \u2022 Optional type : \"submenu\" | \"normal\" | \"separator\" visible # \u2022 Optional visible : IComputedValue < boolean >","title":"Interface: TrayMenuRegistration"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#interface-traymenuregistration","text":"Common . Types .TrayMenuRegistration","title":"Interface: TrayMenuRegistration"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#properties","text":"click enabled id label submenu toolTip type visible","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#click","text":"\u2022 Optional click : ( menuItem : TrayMenuRegistration ) => void","title":"click"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#enabled","text":"\u2022 Optional enabled : boolean | IComputedValue < boolean >","title":"enabled"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#label","text":"\u2022 Optional label : string | IComputedValue < string >","title":"label"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#submenu","text":"\u2022 Optional submenu : TrayMenuRegistration []","title":"submenu"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#tooltip","text":"\u2022 Optional toolTip : string","title":"toolTip"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#type","text":"\u2022 Optional type : \"submenu\" | \"normal\" | \"separator\"","title":"type"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#visible","text":"\u2022 Optional visible : IComputedValue < boolean >","title":"visible"},{"location":"extensions/api/interfaces/Common.Util.Disposable/","text":"Interface: Disposable # Common . Util .Disposable Table of contents # Methods # dispose Methods # dispose # \u25b8 dispose (): void Returns # void","title":"Interface: Disposable"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#interface-disposable","text":"Common . Util .Disposable","title":"Interface: Disposable"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#methods","text":"dispose","title":"Methods"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#dispose","text":"\u25b8 dispose (): void","title":"dispose"},{"location":"extensions/api/interfaces/Common.Util.Disposer/","text":"Interface: Disposer # Common . Util .Disposer Hierarchy # Disposer \u21b3 ExtendableDisposer Callable # Disposer # \u25b8 Disposer (): void Returns # void","title":"Interface: Disposer"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#interface-disposer","text":"Common . Util .Disposer","title":"Interface: Disposer"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#hierarchy","text":"Disposer \u21b3 ExtendableDisposer","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#callable","text":"","title":"Callable"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#disposer","text":"\u25b8 Disposer (): void","title":"Disposer"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/","text":"Interface: ExtendableDisposer # Common . Util .ExtendableDisposer Hierarchy # Disposer \u21b3 ExtendableDisposer Callable # ExtendableDisposer # \u25b8 ExtendableDisposer (): void Returns # void Table of contents # Methods # push Methods # push # \u25b8 push ( ...vals ): void Parameters # Name Type ...vals ( Disposer | ExtendableDisposer | Disposable )[] Returns # void","title":"Interface: ExtendableDisposer"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#interface-extendabledisposer","text":"Common . Util .ExtendableDisposer","title":"Interface: ExtendableDisposer"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#hierarchy","text":"Disposer \u21b3 ExtendableDisposer","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#callable","text":"","title":"Callable"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#extendabledisposer","text":"\u25b8 ExtendableDisposer (): void","title":"ExtendableDisposer"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#methods","text":"push","title":"Methods"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#push","text":"\u25b8 push ( ...vals ): void","title":"push"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/","text":"Interface: CatalogEntityRegistry # Main . Catalog .CatalogEntityRegistry Table of contents # Methods # getItemsForApiKind Methods # getItemsForApiKind # \u25b8 getItemsForApiKind ( apiVersion , kind ): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >[] Parameters # Name Type apiVersion string kind string Returns # CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >[] \u25b8 getItemsForApiKind < T >( apiVersion , kind ): T [] Deprecated use a cast instead of a unbounded type parameter Type parameters # Name Type T extends CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec , T > Parameters # Name Type apiVersion string kind string Returns # T []","title":"Interface: CatalogEntityRegistry"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#interface-catalogentityregistry","text":"Main . Catalog .CatalogEntityRegistry","title":"Interface: CatalogEntityRegistry"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#methods","text":"getItemsForApiKind","title":"Methods"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#getitemsforapikind","text":"\u25b8 getItemsForApiKind ( apiVersion , kind ): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >[]","title":"getItemsForApiKind"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/","text":"Interface: BaseKubeJsonApiObjectMetadata # Main . K8sApi .BaseKubeJsonApiObjectMetadata Type parameters # Name Type Namespaced extends KubeObjectScope Indexable # \u25aa [key: string ]: unknown Table of contents # Properties # annotations clusterName creationTimestamp deletionGracePeriodSeconds deletionTimestamp finalizers generateName generation labels managedFields name namespace ownerReferences resourceVersion selfLink uid Properties # annotations # \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 clusterName # \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 apiserver is going to ignore it if set in create or update request. creationTimestamp # \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 deletionGracePeriodSeconds # \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. deletionTimestamp # \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 finalizers # \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. generateName # \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 generation # \u2022 Optional Readonly generation : number A sequence number representing a specific generation of the desired state. Populated by the system. labels # \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 managedFields # \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. name # \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 namespace # \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 ownerReferences # \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. resourceVersion # \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 selfLink # \u2022 Optional Readonly selfLink : string SelfLink is a URL representing this object. Populated by the system. uid # \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","title":"Interface: BaseKubeJsonApiObjectMetadata"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#interface-basekubejsonapiobjectmetadatanamespaced","text":"Main . K8sApi .BaseKubeJsonApiObjectMetadata","title":"Interface: BaseKubeJsonApiObjectMetadata<Namespaced>"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#type-parameters","text":"Name Type Namespaced extends KubeObjectScope","title":"Type parameters"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#indexable","text":"\u25aa [key: string ]: unknown","title":"Indexable"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#properties","text":"annotations clusterName creationTimestamp deletionGracePeriodSeconds deletionTimestamp finalizers generateName generation labels managedFields name namespace ownerReferences resourceVersion selfLink uid","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#annotations","text":"\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","title":"annotations"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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 apiserver is going to ignore it if set in create or update request.","title":"clusterName"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"creationTimestamp"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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.","title":"deletionGracePeriodSeconds"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"deletionTimestamp"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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.","title":"finalizers"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"generateName"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#generation","text":"\u2022 Optional Readonly generation : number A sequence number representing a specific generation of the desired state. Populated by the system.","title":"generation"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"labels"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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.","title":"managedFields"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"name"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"namespace"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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.","title":"ownerReferences"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"resourceVersion"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#selflink","text":"\u2022 Optional Readonly selfLink : string SelfLink is a URL representing this object. Populated by the system.","title":"selfLink"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"uid"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/","text":"Interface: IKubeApiCluster # Main . K8sApi .IKubeApiCluster Deprecated This type is unused Table of contents # Properties # metadata Properties # metadata # \u2022 metadata : Object Type declaration # Name Type uid string","title":"Interface: IKubeApiCluster"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#interface-ikubeapicluster","text":"Main . K8sApi .IKubeApiCluster Deprecated This type is unused","title":"Interface: IKubeApiCluster"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#properties","text":"metadata","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#metadata","text":"\u2022 metadata : Object","title":"metadata"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/","text":"Interface: ILocalKubeApiConfig # Main . K8sApi .ILocalKubeApiConfig Table of contents # Properties # metadata Properties # metadata # \u2022 metadata : Object Type declaration # Name Type uid string","title":"Interface: ILocalKubeApiConfig"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#interface-ilocalkubeapiconfig","text":"Main . K8sApi .ILocalKubeApiConfig","title":"Interface: ILocalKubeApiConfig"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#properties","text":"metadata","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#metadata","text":"\u2022 metadata : Object","title":"metadata"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/","text":"Interface: IPodContainer # Main . K8sApi .IPodContainer A single application container that you want to run within a pod. Table of contents # Properties # args command env envFrom image imagePullPolicy lifecycle livenessProbe name ports readinessProbe resources securityContext startupProbe stdin stdinOnce terminationMessagePath terminationMessagePolicy tty volumeDevices volumeMounts workingDir Properties # args # \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 command # \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 env # \u2022 Optional env : EnvVar [] List of environment variables to set in the container. Cannot be updated. envFrom # \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. image # \u2022 Optional image : string Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images imagePullPolicy # \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 lifecycle # \u2022 Optional lifecycle : Lifecycle livenessProbe # \u2022 Optional livenessProbe : Probe name # \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. ports # \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. readinessProbe # \u2022 Optional readinessProbe : Probe resources # \u2022 Optional resources : ResourceRequirements securityContext # \u2022 Optional securityContext : SecurityContext startupProbe # \u2022 Optional startupProbe : Probe stdin # \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 stdinOnce # \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 terminationMessagePath # \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\" terminationMessagePolicy # \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\" tty # \u2022 Optional tty : boolean Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default false volumeDevices # \u2022 Optional volumeDevices : VolumeDevice [] volumeDevices is the list of block devices to be used by the container. volumeMounts # \u2022 Optional volumeMounts : VolumeMount [] Pod volumes to mount into the container's filesystem. Cannot be updated. workingDir # \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.","title":"Interface: IPodContainer"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#interface-ipodcontainer","text":"Main . K8sApi .IPodContainer A single application container that you want to run within a pod.","title":"Interface: IPodContainer"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#properties","text":"args command env envFrom image imagePullPolicy lifecycle livenessProbe name ports readinessProbe resources securityContext startupProbe stdin stdinOnce terminationMessagePath terminationMessagePolicy tty volumeDevices volumeMounts workingDir","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#args","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","title":"args"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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","title":"command"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#env","text":"\u2022 Optional env : EnvVar [] List of environment variables to set in the container. Cannot be updated.","title":"env"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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.","title":"envFrom"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#image","text":"\u2022 Optional image : string Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images","title":"image"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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","title":"imagePullPolicy"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#lifecycle","text":"\u2022 Optional lifecycle : Lifecycle","title":"lifecycle"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#livenessprobe","text":"\u2022 Optional livenessProbe : Probe","title":"livenessProbe"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#name","text":"\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.","title":"name"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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.","title":"ports"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#readinessprobe","text":"\u2022 Optional readinessProbe : Probe","title":"readinessProbe"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#resources","text":"\u2022 Optional resources : ResourceRequirements","title":"resources"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#securitycontext","text":"\u2022 Optional securityContext : SecurityContext","title":"securityContext"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#startupprobe","text":"\u2022 Optional startupProbe : Probe","title":"startupProbe"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#stdin","text":"\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","title":"stdin"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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","title":"stdinOnce"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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\"","title":"terminationMessagePath"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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\"","title":"terminationMessagePolicy"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#tty","text":"\u2022 Optional tty : boolean Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default false","title":"tty"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#volumedevices","text":"\u2022 Optional volumeDevices : VolumeDevice [] volumeDevices is the list of block devices to be used by the container.","title":"volumeDevices"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#volumemounts","text":"\u2022 Optional volumeMounts : VolumeMount [] Pod volumes to mount into the container's filesystem. Cannot be updated.","title":"volumeMounts"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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.","title":"workingDir"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/","text":"Interface: IPodContainerStatus # Main . K8sApi .IPodContainerStatus Table of contents # Properties # containerID image imageID lastState name ready restartCount started state Properties # containerID # \u2022 Optional containerID : string image # \u2022 image : string imageID # \u2022 imageID : string lastState # \u2022 Optional lastState : ContainerState name # \u2022 name : string ready # \u2022 ready : boolean restartCount # \u2022 restartCount : number started # \u2022 Optional started : boolean state # \u2022 Optional state : ContainerState","title":"Interface: IPodContainerStatus"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#interface-ipodcontainerstatus","text":"Main . K8sApi .IPodContainerStatus","title":"Interface: IPodContainerStatus"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#properties","text":"containerID image imageID lastState name ready restartCount started state","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#containerid","text":"\u2022 Optional containerID : string","title":"containerID"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#image","text":"\u2022 image : string","title":"image"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#imageid","text":"\u2022 imageID : string","title":"imageID"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#laststate","text":"\u2022 Optional lastState : ContainerState","title":"lastState"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#ready","text":"\u2022 ready : boolean","title":"ready"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#restartcount","text":"\u2022 restartCount : number","title":"restartCount"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#started","text":"\u2022 Optional started : boolean","title":"started"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#state","text":"\u2022 Optional state : ContainerState","title":"state"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/","text":"Interface: IRemoteKubeApiConfig # Main . K8sApi .IRemoteKubeApiConfig Table of contents # Properties # agent cluster user Properties # agent # \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. cluster # \u2022 cluster : Object Type declaration # Name Type caData? string server string skipTLSVerify? boolean user # \u2022 user : Object Type declaration # Name Type clientCertificateData? string clientKeyData? string token? string | () => Promise < string >","title":"Interface: IRemoteKubeApiConfig"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#interface-iremotekubeapiconfig","text":"Main . K8sApi .IRemoteKubeApiConfig","title":"Interface: IRemoteKubeApiConfig"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#properties","text":"agent cluster user","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#agent","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.","title":"agent"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#cluster","text":"\u2022 cluster : Object","title":"cluster"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#user","text":"\u2022 user : Object","title":"user"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/","text":"Interface: ISecretRef # Main . K8sApi .ISecretRef Table of contents # Properties # name namespace Properties # name # \u2022 name : string namespace # \u2022 Optional namespace : string","title":"Interface: ISecretRef"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#interface-isecretref","text":"Main . K8sApi .ISecretRef","title":"Interface: ISecretRef"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#properties","text":"name namespace","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#namespace","text":"\u2022 Optional namespace : string","title":"namespace"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/","text":"Interface: IgnoredKubeApiOptions # Main . K8sApi .IgnoredKubeApiOptions Deprecated This type is only present for backwards compatable typescript support Table of contents # Properties # apiBase isNamespaces kind objectConstructor Properties # apiBase # \u2022 Optional apiBase : any Deprecated this option is overridden and should not be used isNamespaces # \u2022 Optional isNamespaces : any Deprecated this option is overridden and should not be used kind # \u2022 Optional kind : any Deprecated this option is overridden and should not be used objectConstructor # \u2022 Optional objectConstructor : any Deprecated this option is overridden and should not be used","title":"Interface: IgnoredKubeApiOptions"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#interface-ignoredkubeapioptions","text":"Main . K8sApi .IgnoredKubeApiOptions Deprecated This type is only present for backwards compatable typescript support","title":"Interface: IgnoredKubeApiOptions"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#properties","text":"apiBase isNamespaces kind objectConstructor","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#apibase","text":"\u2022 Optional apiBase : any Deprecated this option is overridden and should not be used","title":"apiBase"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#isnamespaces","text":"\u2022 Optional isNamespaces : any Deprecated this option is overridden and should not be used","title":"isNamespaces"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#kind","text":"\u2022 Optional kind : any Deprecated this option is overridden and should not be used","title":"kind"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#objectconstructor","text":"\u2022 Optional objectConstructor : any Deprecated this option is overridden and should not be used","title":"objectConstructor"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/","text":"Interface: KubeJsonApiData # Main . K8sApi .KubeJsonApiData Type parameters # Name Type Metadata extends KubeJsonApiObjectMetadata = KubeJsonApiObjectMetadata Status unknown Spec unknown Hierarchy # JsonApiData \u21b3 KubeJsonApiData Indexable # \u25aa [otherKeys: string ]: unknown Table of contents # Properties # apiVersion kind metadata spec status Properties # apiVersion # \u2022 apiVersion : string kind # \u2022 kind : string metadata # \u2022 metadata : Metadata spec # \u2022 Optional spec : Spec status # \u2022 Optional status : Status","title":"Interface: KubeJsonApiData"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#interface-kubejsonapidatametadata-status-spec","text":"Main . K8sApi .KubeJsonApiData","title":"Interface: KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#type-parameters","text":"Name Type Metadata extends KubeJsonApiObjectMetadata = KubeJsonApiObjectMetadata Status unknown Spec unknown","title":"Type parameters"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#hierarchy","text":"JsonApiData \u21b3 KubeJsonApiData","title":"Hierarchy"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#indexable","text":"\u25aa [otherKeys: string ]: unknown","title":"Indexable"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#properties","text":"apiVersion kind metadata spec status","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#spec","text":"\u2022 Optional spec : Spec","title":"spec"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#status","text":"\u2022 Optional status : Status","title":"status"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/","text":"Interface: KubeObjectStoreLoadAllParams # Main . K8sApi .KubeObjectStoreLoadAllParams Table of contents # Properties # merge namespaces onLoadFailure reqInit Properties # merge # \u2022 Optional merge : boolean namespaces # \u2022 Optional namespaces : string [] onLoadFailure # \u2022 Optional onLoadFailure : OnLoadFailure A function that is called when listing fails. If set then blocks errors being rejected with reqInit # \u2022 Optional reqInit : RequestInit","title":"Interface: KubeObjectStoreLoadAllParams"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#interface-kubeobjectstoreloadallparams","text":"Main . K8sApi .KubeObjectStoreLoadAllParams","title":"Interface: KubeObjectStoreLoadAllParams"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#properties","text":"merge namespaces onLoadFailure reqInit","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#merge","text":"\u2022 Optional merge : boolean","title":"merge"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#namespaces","text":"\u2022 Optional namespaces : string []","title":"namespaces"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#onloadfailure","text":"\u2022 Optional onLoadFailure : OnLoadFailure A function that is called when listing fails. If set then blocks errors being rejected with","title":"onLoadFailure"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#reqinit","text":"\u2022 Optional reqInit : RequestInit","title":"reqInit"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/","text":"Interface: KubeObjectStoreLoadingParams # Main . K8sApi .KubeObjectStoreLoadingParams Table of contents # Properties # namespaces onLoadFailure reqInit Properties # namespaces # \u2022 namespaces : string [] onLoadFailure # \u2022 Optional onLoadFailure : OnLoadFailure A function that is called when listing fails. If set then blocks errors being rejected with reqInit # \u2022 Optional reqInit : RequestInit","title":"Interface: KubeObjectStoreLoadingParams"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#interface-kubeobjectstoreloadingparams","text":"Main . K8sApi .KubeObjectStoreLoadingParams","title":"Interface: KubeObjectStoreLoadingParams"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#properties","text":"namespaces onLoadFailure reqInit","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#namespaces","text":"\u2022 namespaces : string []","title":"namespaces"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#onloadfailure","text":"\u2022 Optional onLoadFailure : OnLoadFailure A function that is called when listing fails. If set then blocks errors being rejected with","title":"onLoadFailure"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#reqinit","text":"\u2022 Optional reqInit : RequestInit","title":"reqInit"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/","text":"Interface: KubeObjectStoreSubscribeParams # Main . K8sApi .KubeObjectStoreSubscribeParams Table of contents # Properties # abortController onLoadFailure Properties # abortController # \u2022 Optional abortController : AbortController An optional parent abort controller onLoadFailure # \u2022 Optional onLoadFailure : OnLoadFailure A function that is called when listing fails. If set then blocks errors being rejected with","title":"Interface: KubeObjectStoreSubscribeParams"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#interface-kubeobjectstoresubscribeparams","text":"Main . K8sApi .KubeObjectStoreSubscribeParams","title":"Interface: KubeObjectStoreSubscribeParams"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#properties","text":"abortController onLoadFailure","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#abortcontroller","text":"\u2022 Optional abortController : AbortController An optional parent abort controller","title":"abortController"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#onloadfailure","text":"\u2022 Optional onLoadFailure : OnLoadFailure A function that is called when listing fails. If set then blocks errors being rejected with","title":"onLoadFailure"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/","text":"Interface: KubeStatusData # Main . K8sApi .KubeStatusData Table of contents # Properties # apiVersion code kind message reason Properties # apiVersion # \u2022 apiVersion : string code # \u2022 code : number kind # \u2022 kind : string message # \u2022 Optional message : string reason # \u2022 Optional reason : string","title":"Interface: KubeStatusData"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#interface-kubestatusdata","text":"Main . K8sApi .KubeStatusData","title":"Interface: KubeStatusData"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#properties","text":"apiVersion code kind message reason","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#code","text":"\u2022 code : number","title":"code"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#message","text":"\u2022 Optional message : string","title":"message"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#reason","text":"\u2022 Optional reason : string","title":"reason"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/","text":"Interface: OwnerReference # Main . K8sApi .OwnerReference Table of contents # Properties # apiVersion blockOwnerDeletion controller kind name uid Properties # apiVersion # \u2022 apiVersion : string blockOwnerDeletion # \u2022 Optional blockOwnerDeletion : boolean controller # \u2022 Optional controller : boolean kind # \u2022 kind : string name # \u2022 name : string uid # \u2022 uid : string","title":"Interface: OwnerReference"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#interface-ownerreference","text":"Main . K8sApi .OwnerReference","title":"Interface: OwnerReference"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#properties","text":"apiVersion blockOwnerDeletion controller kind name uid","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#blockownerdeletion","text":"\u2022 Optional blockOwnerDeletion : boolean","title":"blockOwnerDeletion"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#controller","text":"\u2022 Optional controller : boolean","title":"controller"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#uid","text":"\u2022 uid : string","title":"uid"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/","text":"Interface: AdditionalCategoryColumnRegistration # Renderer . Component .AdditionalCategoryColumnRegistration This is the type used to declare new catalog category columns Hierarchy # CategoryColumnRegistration \u21b3 AdditionalCategoryColumnRegistration Table of contents # Properties # group id kind priority renderCell searchFilter sortCallback titleProps Properties # group # \u2022 group : string The catalog entity group that is declared by the category for this registration e.g. - \"entity.k8slens.dev\" id # \u2022 id : string This value MUST to be unique to your extension Inherited from # CategoryColumnRegistration . id kind # \u2022 kind : string The catalog entity kind that is declared by the category for this registration e.g. - \"KubernetesCluster\" priority # \u2022 Optional priority : number The sorting order value. Default 50 Inherited from # CategoryColumnRegistration . priority renderCell # \u2022 renderCell : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => ReactNode Type declaration # \u25b8 ( entity ): ReactNode This function will be called to generate the cells (on demand) for the column Parameters # Name Type entity CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Returns # ReactNode Inherited from # CategoryColumnRegistration . renderCell searchFilter # \u2022 Optional searchFilter : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | string [] Type declaration # \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. Parameters # Name Type entity CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Returns # string | string [] Inherited from # CategoryColumnRegistration . searchFilter sortCallback # \u2022 Optional sortCallback : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | number | ( string | number )[] Type declaration # \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. Parameters # Name Type entity CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Returns # string | number | ( string | number )[] Inherited from # CategoryColumnRegistration . sortCallback titleProps # \u2022 titleProps : TitleCellProps This function will be used to generate the columns title cell. Inherited from # CategoryColumnRegistration . titleProps","title":"Interface: AdditionalCategoryColumnRegistration"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#interface-additionalcategorycolumnregistration","text":"Renderer . Component .AdditionalCategoryColumnRegistration This is the type used to declare new catalog category columns","title":"Interface: AdditionalCategoryColumnRegistration"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#hierarchy","text":"CategoryColumnRegistration \u21b3 AdditionalCategoryColumnRegistration","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#properties","text":"group id kind priority renderCell searchFilter sortCallback titleProps","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#group","text":"\u2022 group : string The catalog entity group that is declared by the category for this registration e.g. - \"entity.k8slens.dev\"","title":"group"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#id","text":"\u2022 id : string This value MUST to be unique to your extension","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#kind","text":"\u2022 kind : string The catalog entity kind that is declared by the category for this registration e.g. - \"KubernetesCluster\"","title":"kind"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#priority","text":"\u2022 Optional priority : number The sorting order value. Default 50","title":"priority"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#rendercell","text":"\u2022 renderCell : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => ReactNode","title":"renderCell"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#searchfilter","text":"\u2022 Optional searchFilter : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | string []","title":"searchFilter"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#sortcallback","text":"\u2022 Optional sortCallback : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | number | ( string | number )[]","title":"sortCallback"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#titleprops","text":"\u2022 titleProps : TitleCellProps This function will be used to generate the columns title cell.","title":"titleProps"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/","text":"Interface: BadgeProps # Renderer . Component .BadgeProps Hierarchy # HTMLAttributes < HTMLDivElement > \u21b3 BadgeProps Table of contents # Properties # disabled expandable flat label scrollable small Properties # disabled # \u2022 Optional disabled : boolean expandable # \u2022 Optional expandable : boolean flat # \u2022 Optional flat : boolean label # \u2022 Optional label : ReactNode scrollable # \u2022 Optional scrollable : boolean small # \u2022 Optional small : boolean","title":"Interface: BadgeProps"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#interface-badgeprops","text":"Renderer . Component .BadgeProps","title":"Interface: BadgeProps"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#hierarchy","text":"HTMLAttributes < HTMLDivElement > \u21b3 BadgeProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#properties","text":"disabled expandable flat label scrollable small","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#expandable","text":"\u2022 Optional expandable : boolean","title":"expandable"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#flat","text":"\u2022 Optional flat : boolean","title":"flat"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#label","text":"\u2022 Optional label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#scrollable","text":"\u2022 Optional scrollable : boolean","title":"scrollable"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#small","text":"\u2022 Optional small : boolean","title":"small"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/","text":"Interface: BarChartProps # Renderer . Component .BarChartProps Hierarchy # ChartProps \u21b3 BarChartProps Table of contents # Properties # className data data-testid height legendColors legendPosition name options plugins redraw showChart showLegend timeLabelStep title type width Properties # className # \u2022 Optional className : string Inherited from # ChartProps.className data # \u2022 data : ChartData Inherited from # ChartProps.data data-testid # \u2022 Optional data-testid : string Inherited from # ChartProps.data-testid height # \u2022 Optional height : string | number Inherited from # ChartProps.height legendColors # \u2022 Optional legendColors : string [] Inherited from # ChartProps.legendColors legendPosition # \u2022 Optional legendPosition : \"bottom\" Inherited from # ChartProps.legendPosition name # \u2022 Optional name : string options # \u2022 Optional options : ChartOptions Inherited from # ChartProps.options plugins # \u2022 Optional plugins : PluginServiceRegistrationOptions [] Inherited from # ChartProps.plugins redraw # \u2022 Optional redraw : boolean Inherited from # ChartProps.redraw showChart # \u2022 Optional showChart : boolean Inherited from # ChartProps.showChart showLegend # \u2022 Optional showLegend : boolean Inherited from # ChartProps.showLegend timeLabelStep # \u2022 Optional timeLabelStep : number title # \u2022 Optional title : string Inherited from # ChartProps.title type # \u2022 Optional type : ChartKind Inherited from # ChartProps.type width # \u2022 Optional width : string | number Inherited from # ChartProps.width","title":"Interface: BarChartProps"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#interface-barchartprops","text":"Renderer . Component .BarChartProps","title":"Interface: BarChartProps"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#hierarchy","text":"ChartProps \u21b3 BarChartProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#properties","text":"className data data-testid height legendColors legendPosition name options plugins redraw showChart showLegend timeLabelStep title type width","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#data","text":"\u2022 data : ChartData","title":"data"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#height","text":"\u2022 Optional height : string | number","title":"height"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#legendcolors","text":"\u2022 Optional legendColors : string []","title":"legendColors"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#legendposition","text":"\u2022 Optional legendPosition : \"bottom\"","title":"legendPosition"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#name","text":"\u2022 Optional name : string","title":"name"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#options","text":"\u2022 Optional options : ChartOptions","title":"options"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#plugins","text":"\u2022 Optional plugins : PluginServiceRegistrationOptions []","title":"plugins"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#redraw","text":"\u2022 Optional redraw : boolean","title":"redraw"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#showchart","text":"\u2022 Optional showChart : boolean","title":"showChart"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#showlegend","text":"\u2022 Optional showLegend : boolean","title":"showLegend"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#timelabelstep","text":"\u2022 Optional timeLabelStep : number","title":"timeLabelStep"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#type","text":"\u2022 Optional type : ChartKind","title":"type"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#width","text":"\u2022 Optional width : string | number","title":"width"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/","text":"Interface: BaseIconProps # Renderer . Component .BaseIconProps Hierarchy # BaseIconProps \u21b3 IconProps Table of contents # Properties # active big data-testid disabled focusable href interactive link material size small smallest sticker svg Properties # active # \u2022 Optional active : boolean apply active-state styles big # \u2022 Optional big : boolean A pre-defined icon-size data-testid # \u2022 Optional data-testid : string disabled # \u2022 Optional disabled : boolean focusable # \u2022 Optional focusable : boolean Allow focus to the icon to show .active styles. Only applicable if interactive is true . Default true href # \u2022 Optional href : string render icon as hyperlink interactive # \u2022 Optional interactive : boolean indicates that icon is interactive and highlight it on focus/hover link # \u2022 Optional link : LocationDescriptor < unknown > render icon as NavLink from react-router-dom material # \u2022 Optional material : string One of the names from https://material.io/icons/ size # \u2022 Optional size : string | number The icon size (css units) small # \u2022 Optional small : boolean A pre-defined icon-size smallest # \u2022 Optional smallest : boolean A pre-defined icon-size sticker # \u2022 Optional sticker : boolean svg # \u2022 Optional svg : string Either an SVG XML or one of the following names - 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","title":"Interface: BaseIconProps"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#interface-baseiconprops","text":"Renderer . Component .BaseIconProps","title":"Interface: BaseIconProps"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#hierarchy","text":"BaseIconProps \u21b3 IconProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#properties","text":"active big data-testid disabled focusable href interactive link material size small smallest sticker svg","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#active","text":"\u2022 Optional active : boolean apply active-state styles","title":"active"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#big","text":"\u2022 Optional big : boolean A pre-defined icon-size","title":"big"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#focusable","text":"\u2022 Optional focusable : boolean Allow focus to the icon to show .active styles. Only applicable if interactive is true . Default true","title":"focusable"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#href","text":"\u2022 Optional href : string render icon as hyperlink","title":"href"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#interactive","text":"\u2022 Optional interactive : boolean indicates that icon is interactive and highlight it on focus/hover","title":"interactive"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#link","text":"\u2022 Optional link : LocationDescriptor < unknown > render icon as NavLink from react-router-dom","title":"link"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#material","text":"\u2022 Optional material : string One of the names from https://material.io/icons/","title":"material"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#size","text":"\u2022 Optional size : string | number The icon size (css units)","title":"size"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#small","text":"\u2022 Optional small : boolean A pre-defined icon-size","title":"small"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#smallest","text":"\u2022 Optional smallest : boolean A pre-defined icon-size","title":"smallest"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#sticker","text":"\u2022 Optional sticker : boolean","title":"sticker"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#svg","text":"\u2022 Optional svg : string Either an SVG XML or one of the following names - 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","title":"svg"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/","text":"Interface: ButtonProps # Renderer . Component .ButtonProps Hierarchy # ButtonHTMLAttributes < any > \u21b3 ButtonProps Table of contents # Properties # accent active big hidden href label light outlined plain primary round target waiting Properties # accent # \u2022 Optional accent : boolean active # \u2022 Optional active : boolean big # \u2022 Optional big : boolean hidden # \u2022 Optional hidden : boolean Overrides # ButtonHTMLAttributes.hidden href # \u2022 Optional href : string label # \u2022 Optional label : ReactNode light # \u2022 Optional light : boolean outlined # \u2022 Optional outlined : boolean plain # \u2022 Optional plain : boolean primary # \u2022 Optional primary : boolean round # \u2022 Optional round : boolean target # \u2022 Optional target : \"_blank\" waiting # \u2022 Optional waiting : boolean","title":"Interface: ButtonProps"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#interface-buttonprops","text":"Renderer . Component .ButtonProps","title":"Interface: ButtonProps"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#hierarchy","text":"ButtonHTMLAttributes < any > \u21b3 ButtonProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#properties","text":"accent active big hidden href label light outlined plain primary round target waiting","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#accent","text":"\u2022 Optional accent : boolean","title":"accent"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#big","text":"\u2022 Optional big : boolean","title":"big"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#href","text":"\u2022 Optional href : string","title":"href"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#label","text":"\u2022 Optional label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#light","text":"\u2022 Optional light : boolean","title":"light"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#outlined","text":"\u2022 Optional outlined : boolean","title":"outlined"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#plain","text":"\u2022 Optional plain : boolean","title":"plain"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#primary","text":"\u2022 Optional primary : boolean","title":"primary"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#round","text":"\u2022 Optional round : boolean","title":"round"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#target","text":"\u2022 Optional target : \"_blank\"","title":"target"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#waiting","text":"\u2022 Optional waiting : boolean","title":"waiting"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/","text":"Interface: CheckboxProps # Renderer . Component .CheckboxProps Table of contents # Properties # children className disabled inline label value Methods # onChange Properties # children # \u2022 Optional children : SingleOrMany < ReactChild | ReactFragment > className # \u2022 Optional className : string disabled # \u2022 Optional disabled : boolean inline # \u2022 Optional inline : boolean label # \u2022 Optional label : ReactNode value # \u2022 Optional value : boolean Methods # onChange # \u25b8 Optional onChange ( value , evt ): void Parameters # Name Type value boolean evt ChangeEvent < HTMLInputElement > Returns # void","title":"Interface: CheckboxProps"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#interface-checkboxprops","text":"Renderer . Component .CheckboxProps","title":"Interface: CheckboxProps"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#properties","text":"children className disabled inline label value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#methods","text":"onChange","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#children","text":"\u2022 Optional children : SingleOrMany < ReactChild | ReactFragment >","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#inline","text":"\u2022 Optional inline : boolean","title":"inline"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#label","text":"\u2022 Optional label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#value","text":"\u2022 Optional value : boolean","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#onchange","text":"\u25b8 Optional onChange ( value , evt ): void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/","text":"Interface: ConfirmDialogBooleanParams # Renderer . Component .ConfirmDialogBooleanParams Hierarchy # ConfirmDialogBooleanParams \u21b3 ConfirmDialogParams Table of contents # Properties # cancelButtonProps icon labelCancel labelOk message okButtonProps Properties # cancelButtonProps # \u2022 Optional cancelButtonProps : Partial < ButtonProps > icon # \u2022 Optional icon : ReactNode labelCancel # \u2022 Optional labelCancel : ReactNode labelOk # \u2022 Optional labelOk : ReactNode message # \u2022 message : ReactNode okButtonProps # \u2022 Optional okButtonProps : Partial < ButtonProps >","title":"Interface: ConfirmDialogBooleanParams"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#interface-confirmdialogbooleanparams","text":"Renderer . Component .ConfirmDialogBooleanParams","title":"Interface: ConfirmDialogBooleanParams"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#hierarchy","text":"ConfirmDialogBooleanParams \u21b3 ConfirmDialogParams","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#properties","text":"cancelButtonProps icon labelCancel labelOk message okButtonProps","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#cancelbuttonprops","text":"\u2022 Optional cancelButtonProps : Partial < ButtonProps >","title":"cancelButtonProps"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#icon","text":"\u2022 Optional icon : ReactNode","title":"icon"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#labelcancel","text":"\u2022 Optional labelCancel : ReactNode","title":"labelCancel"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#labelok","text":"\u2022 Optional labelOk : ReactNode","title":"labelOk"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#message","text":"\u2022 message : ReactNode","title":"message"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#okbuttonprops","text":"\u2022 Optional okButtonProps : Partial < ButtonProps >","title":"okButtonProps"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/","text":"Interface: ConfirmDialogParams # Renderer . Component .ConfirmDialogParams Hierarchy # ConfirmDialogBooleanParams \u21b3 ConfirmDialogParams Table of contents # Properties # cancel cancelButtonProps icon labelCancel labelOk message ok okButtonProps Properties # cancel # \u2022 Optional cancel : () => any Type declaration # \u25b8 (): any Returns # any cancelButtonProps # \u2022 Optional cancelButtonProps : Partial < ButtonProps > Inherited from # ConfirmDialogBooleanParams . cancelButtonProps icon # \u2022 Optional icon : ReactNode Inherited from # ConfirmDialogBooleanParams . icon labelCancel # \u2022 Optional labelCancel : ReactNode Inherited from # ConfirmDialogBooleanParams . labelCancel labelOk # \u2022 Optional labelOk : ReactNode Inherited from # ConfirmDialogBooleanParams . labelOk message # \u2022 message : ReactNode Inherited from # ConfirmDialogBooleanParams . message ok # \u2022 Optional ok : () => any Type declaration # \u25b8 (): any Returns # any okButtonProps # \u2022 Optional okButtonProps : Partial < ButtonProps > Inherited from # ConfirmDialogBooleanParams . okButtonProps","title":"Interface: ConfirmDialogParams"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#interface-confirmdialogparams","text":"Renderer . Component .ConfirmDialogParams","title":"Interface: ConfirmDialogParams"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#hierarchy","text":"ConfirmDialogBooleanParams \u21b3 ConfirmDialogParams","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#properties","text":"cancel cancelButtonProps icon labelCancel labelOk message ok okButtonProps","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#cancel","text":"\u2022 Optional cancel : () => any","title":"cancel"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#cancelbuttonprops","text":"\u2022 Optional cancelButtonProps : Partial < ButtonProps >","title":"cancelButtonProps"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#icon","text":"\u2022 Optional icon : ReactNode","title":"icon"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#labelcancel","text":"\u2022 Optional labelCancel : ReactNode","title":"labelCancel"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#labelok","text":"\u2022 Optional labelOk : ReactNode","title":"labelOk"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#message","text":"\u2022 message : ReactNode","title":"message"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#ok","text":"\u2022 Optional ok : () => any","title":"ok"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#okbuttonprops","text":"\u2022 Optional okButtonProps : Partial < ButtonProps >","title":"okButtonProps"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/","text":"Interface: ConfirmDialogProps # Renderer . Component .ConfirmDialogProps Hierarchy # Partial < DialogProps > \u21b3 ConfirmDialogProps Table of contents # Properties # animated children className close data-testid isOpen modal onClose onOpen open pinned Properties # animated # \u2022 Optional animated : boolean Inherited from # Partial.animated children # \u2022 Optional children : ReactNode | ReactNode [] Inherited from # Partial.children className # \u2022 Optional className : string Inherited from # Partial.className close # \u2022 Optional close : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # Partial.close data-testid # \u2022 Optional data-testid : string Inherited from # Partial.data-testid isOpen # \u2022 Optional isOpen : boolean Inherited from # Partial.isOpen modal # \u2022 Optional modal : boolean Inherited from # Partial.modal onClose # \u2022 Optional onClose : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # Partial.onClose onOpen # \u2022 Optional onOpen : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # Partial.onOpen open # \u2022 Optional open : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # Partial.open pinned # \u2022 Optional pinned : boolean Inherited from # Partial.pinned","title":"Interface: ConfirmDialogProps"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#interface-confirmdialogprops","text":"Renderer . Component .ConfirmDialogProps","title":"Interface: ConfirmDialogProps"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#hierarchy","text":"Partial < DialogProps > \u21b3 ConfirmDialogProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#properties","text":"animated children className close data-testid isOpen modal onClose onOpen open pinned","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#animated","text":"\u2022 Optional animated : boolean","title":"animated"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#children","text":"\u2022 Optional children : ReactNode | ReactNode []","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#close","text":"\u2022 Optional close : () => void","title":"close"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#isopen","text":"\u2022 Optional isOpen : boolean","title":"isOpen"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#modal","text":"\u2022 Optional modal : boolean","title":"modal"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#onclose","text":"\u2022 Optional onClose : () => void","title":"onClose"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#onopen","text":"\u2022 Optional onOpen : () => void","title":"onOpen"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#open","text":"\u2022 Optional open : () => void","title":"open"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#pinned","text":"\u2022 Optional pinned : boolean","title":"pinned"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/","text":"Interface: CreateNotificationOptions # Renderer . Component .CreateNotificationOptions Table of contents # Properties # id timeout Methods # onClose Properties # id # \u2022 Optional id : NotificationId timeout # \u2022 Optional timeout : number Methods # onClose # \u25b8 Optional onClose (): void Returns # void","title":"Interface: CreateNotificationOptions"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#interface-createnotificationoptions","text":"Renderer . Component .CreateNotificationOptions","title":"Interface: CreateNotificationOptions"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#properties","text":"id timeout","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#methods","text":"onClose","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#id","text":"\u2022 Optional id : NotificationId","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#timeout","text":"\u2022 Optional timeout : number","title":"timeout"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#onclose","text":"\u25b8 Optional onClose (): void","title":"onClose"},{"location":"extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/","text":"Interface: CustomPlaceholderProps # Renderer . Component .CustomPlaceholderProps Hierarchy # PlaceholderProps < NamespaceSelectFilterOption , true > \u21b3 CustomPlaceholderProps","title":"Interface: CustomPlaceholderProps"},{"location":"extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/#interface-customplaceholderprops","text":"Renderer . Component .CustomPlaceholderProps","title":"Interface: CustomPlaceholderProps"},{"location":"extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/#hierarchy","text":"PlaceholderProps < NamespaceSelectFilterOption , true > \u21b3 CustomPlaceholderProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/","text":"Interface: DialogProps # Renderer . Component .DialogProps Table of contents # Properties # animated children className close data-testid isOpen modal onClose onOpen open pinned Properties # animated # \u2022 Optional animated : boolean children # \u2022 Optional children : ReactNode | ReactNode [] className # \u2022 Optional className : string close # \u2022 Optional close : () => void Type declaration # \u25b8 (): void Returns # void data-testid # \u2022 Optional data-testid : string isOpen # \u2022 Optional isOpen : boolean modal # \u2022 Optional modal : boolean onClose # \u2022 Optional onClose : () => void Type declaration # \u25b8 (): void Returns # void onOpen # \u2022 Optional onOpen : () => void Type declaration # \u25b8 (): void Returns # void open # \u2022 Optional open : () => void Type declaration # \u25b8 (): void Returns # void pinned # \u2022 Optional pinned : boolean","title":"Interface: DialogProps"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#interface-dialogprops","text":"Renderer . Component .DialogProps","title":"Interface: DialogProps"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#properties","text":"animated children className close data-testid isOpen modal onClose onOpen open pinned","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#animated","text":"\u2022 Optional animated : boolean","title":"animated"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#children","text":"\u2022 Optional children : ReactNode | ReactNode []","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#close","text":"\u2022 Optional close : () => void","title":"close"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#isopen","text":"\u2022 Optional isOpen : boolean","title":"isOpen"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#modal","text":"\u2022 Optional modal : boolean","title":"modal"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#onclose","text":"\u2022 Optional onClose : () => void","title":"onClose"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#onopen","text":"\u2022 Optional onOpen : () => void","title":"onOpen"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#open","text":"\u2022 Optional open : () => void","title":"open"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#pinned","text":"\u2022 Optional pinned : boolean","title":"pinned"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/","text":"Interface: DrawerItemLabelsProps # Renderer . Component .DrawerItemLabelsProps Hierarchy # DrawerItemProps \u21b3 DrawerItemLabelsProps Table of contents # Properties # hidden labels labelsOnly name renderBooleans title Properties # hidden # \u2022 Optional hidden : boolean Inherited from # DrawerItemProps . hidden labels # \u2022 labels : string [] | Partial < Record < string , string >> labelsOnly # \u2022 Optional labelsOnly : boolean Inherited from # DrawerItemProps . labelsOnly name # \u2022 name : ReactNode Inherited from # DrawerItemProps . name renderBooleans # \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. Inherited from # DrawerItemProps . renderBooleans title # \u2022 Optional title : string Inherited from # DrawerItemProps . title","title":"Interface: DrawerItemLabelsProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#interface-draweritemlabelsprops","text":"Renderer . Component .DrawerItemLabelsProps","title":"Interface: DrawerItemLabelsProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#hierarchy","text":"DrawerItemProps \u21b3 DrawerItemLabelsProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#properties","text":"hidden labels labelsOnly name renderBooleans title","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#labels","text":"\u2022 labels : string [] | Partial < Record < string , string >>","title":"labels"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#labelsonly","text":"\u2022 Optional labelsOnly : boolean","title":"labelsOnly"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#name","text":"\u2022 name : ReactNode","title":"name"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#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.","title":"renderBooleans"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/","text":"Interface: DrawerItemProps # Renderer . Component .DrawerItemProps Hierarchy # HTMLAttributes < HTMLDivElement > \u21b3 DrawerItemProps \u21b3\u21b3 DrawerItemLabelsProps Table of contents # Properties # hidden labelsOnly name renderBooleans title Properties # hidden # \u2022 Optional hidden : boolean Overrides # React.HTMLAttributes.hidden labelsOnly # \u2022 Optional labelsOnly : boolean name # \u2022 name : ReactNode renderBooleans # \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. title # \u2022 Optional title : string Overrides # React.HTMLAttributes.title","title":"Interface: DrawerItemProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#interface-draweritemprops","text":"Renderer . Component .DrawerItemProps","title":"Interface: DrawerItemProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#hierarchy","text":"HTMLAttributes < HTMLDivElement > \u21b3 DrawerItemProps \u21b3\u21b3 DrawerItemLabelsProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#properties","text":"hidden labelsOnly name renderBooleans title","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#labelsonly","text":"\u2022 Optional labelsOnly : boolean","title":"labelsOnly"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#name","text":"\u2022 name : ReactNode","title":"name"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#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.","title":"renderBooleans"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/","text":"Interface: DrawerParamTogglerProps # Renderer . Component .DrawerParamTogglerProps Table of contents # Properties # children label Properties # children # \u2022 children : ReactNode | ReactNode [] label # \u2022 label : string | number","title":"Interface: DrawerParamTogglerProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#interface-drawerparamtogglerprops","text":"Renderer . Component .DrawerParamTogglerProps","title":"Interface: DrawerParamTogglerProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#properties","text":"children label","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#children","text":"\u2022 children : ReactNode | ReactNode []","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#label","text":"\u2022 label : string | number","title":"label"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/","text":"Interface: DrawerProps # Renderer . Component .DrawerProps Table of contents # Properties # animation children className contentClass data-testid onClose open position size testIdForClose title toolbar usePortal Properties # animation # \u2022 Optional animation : string children # \u2022 Optional children : SingleOrMany < ReactNode > className # \u2022 Optional className : string | object contentClass # \u2022 Optional contentClass : string | object data-testid # \u2022 Optional data-testid : string onClose # \u2022 Optional onClose : () => void Type declaration # \u25b8 (): void Returns # void open # \u2022 open : boolean position # \u2022 Optional position : DrawerPosition size # \u2022 Optional size : string The width or heigh (depending on position ) of the Drawer. If not set then the Drawer will be resizable. testIdForClose # \u2022 Optional testIdForClose : string title # \u2022 title : ReactNode toolbar # \u2022 Optional toolbar : ReactNode usePortal # \u2022 Optional usePortal : boolean","title":"Interface: DrawerProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#interface-drawerprops","text":"Renderer . Component .DrawerProps","title":"Interface: DrawerProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#properties","text":"animation children className contentClass data-testid onClose open position size testIdForClose title toolbar usePortal","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#animation","text":"\u2022 Optional animation : string","title":"animation"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#children","text":"\u2022 Optional children : SingleOrMany < ReactNode >","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#classname","text":"\u2022 Optional className : string | object","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#contentclass","text":"\u2022 Optional contentClass : string | object","title":"contentClass"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#onclose","text":"\u2022 Optional onClose : () => void","title":"onClose"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#open","text":"\u2022 open : boolean","title":"open"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#position","text":"\u2022 Optional position : DrawerPosition","title":"position"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#size","text":"\u2022 Optional size : string The width or heigh (depending on position ) of the Drawer. If not set then the Drawer will be resizable.","title":"size"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#testidforclose","text":"\u2022 Optional testIdForClose : string","title":"testIdForClose"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#title","text":"\u2022 title : ReactNode","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#toolbar","text":"\u2022 Optional toolbar : ReactNode","title":"toolbar"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#useportal","text":"\u2022 Optional usePortal : boolean","title":"usePortal"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/","text":"Interface: DrawerTitleProps # Renderer . Component .DrawerTitleProps Table of contents # Properties # children className size title Properties # children # \u2022 Optional children : ReactNode className # \u2022 Optional className : string size # \u2022 Optional size : \"title\" | \"sub-title\" Specifies how large this title is Default \"title\" title # \u2022 Optional title : ReactNode Deprecated Prefer passing the value as children","title":"Interface: DrawerTitleProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#interface-drawertitleprops","text":"Renderer . Component .DrawerTitleProps","title":"Interface: DrawerTitleProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#properties","text":"children className size title","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#size","text":"\u2022 Optional size : \"title\" | \"sub-title\" Specifies how large this title is Default \"title\"","title":"size"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#title","text":"\u2022 Optional title : ReactNode Deprecated Prefer passing the value as children","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/","text":"Interface: IconDataFnArg # Renderer . Component .IconDataFnArg Table of contents # Properties # isDirty Properties # isDirty # \u2022 isDirty : boolean","title":"Interface: IconDataFnArg"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#interface-icondatafnarg","text":"Renderer . Component .IconDataFnArg","title":"Interface: IconDataFnArg"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#properties","text":"isDirty","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#isdirty","text":"\u2022 isDirty : boolean","title":"isDirty"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/","text":"Interface: IconProps # Renderer . Component .IconProps Hierarchy # HTMLAttributes < any > BaseIconProps \u21b3 IconProps Table of contents # Properties # active big data-testid disabled focusable href interactive link material size small smallest sticker svg Properties # active # \u2022 Optional active : boolean apply active-state styles Inherited from # BaseIconProps . active big # \u2022 Optional big : boolean A pre-defined icon-size Inherited from # BaseIconProps . big data-testid # \u2022 Optional data-testid : string Inherited from # BaseIconProps . data-testid disabled # \u2022 Optional disabled : boolean Inherited from # BaseIconProps . disabled focusable # \u2022 Optional focusable : boolean Allow focus to the icon to show .active styles. Only applicable if interactive is true . Default true Inherited from # BaseIconProps . focusable href # \u2022 Optional href : string render icon as hyperlink Inherited from # BaseIconProps . href interactive # \u2022 Optional interactive : boolean indicates that icon is interactive and highlight it on focus/hover Inherited from # BaseIconProps . interactive link # \u2022 Optional link : LocationDescriptor < unknown > render icon as NavLink from react-router-dom Inherited from # BaseIconProps . link material # \u2022 Optional material : string One of the names from https://material.io/icons/ Inherited from # BaseIconProps . material size # \u2022 Optional size : string | number The icon size (css units) Inherited from # BaseIconProps . size small # \u2022 Optional small : boolean A pre-defined icon-size Inherited from # BaseIconProps . small smallest # \u2022 Optional smallest : boolean A pre-defined icon-size Inherited from # BaseIconProps . smallest sticker # \u2022 Optional sticker : boolean Inherited from # BaseIconProps . sticker svg # \u2022 Optional svg : string Either an SVG XML or one of the following names - 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 Inherited from # BaseIconProps . svg","title":"Interface: IconProps"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#interface-iconprops","text":"Renderer . Component .IconProps","title":"Interface: IconProps"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#hierarchy","text":"HTMLAttributes < any > BaseIconProps \u21b3 IconProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#properties","text":"active big data-testid disabled focusable href interactive link material size small smallest sticker svg","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#active","text":"\u2022 Optional active : boolean apply active-state styles","title":"active"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#big","text":"\u2022 Optional big : boolean A pre-defined icon-size","title":"big"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#focusable","text":"\u2022 Optional focusable : boolean Allow focus to the icon to show .active styles. Only applicable if interactive is true . Default true","title":"focusable"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#href","text":"\u2022 Optional href : string render icon as hyperlink","title":"href"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#interactive","text":"\u2022 Optional interactive : boolean indicates that icon is interactive and highlight it on focus/hover","title":"interactive"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#link","text":"\u2022 Optional link : LocationDescriptor < unknown > render icon as NavLink from react-router-dom","title":"link"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#material","text":"\u2022 Optional material : string One of the names from https://material.io/icons/","title":"material"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#size","text":"\u2022 Optional size : string | number The icon size (css units)","title":"size"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#small","text":"\u2022 Optional small : boolean A pre-defined icon-size","title":"small"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#smallest","text":"\u2022 Optional smallest : boolean A pre-defined icon-size","title":"smallest"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#sticker","text":"\u2022 Optional sticker : boolean","title":"sticker"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#svg","text":"\u2022 Optional svg : string Either an SVG XML or one of the following names - 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","title":"svg"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/","text":"Interface: KubeEventDetailsProps # Renderer . Component .KubeEventDetailsProps Table of contents # Properties # object Properties # object # \u2022 object : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >","title":"Interface: KubeEventDetailsProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#interface-kubeeventdetailsprops","text":"Renderer . Component .KubeEventDetailsProps","title":"Interface: KubeEventDetailsProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#properties","text":"object","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#object","text":"\u2022 object : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >","title":"object"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/","text":"Interface: KubeObjectDetailsProps # Renderer . Component .KubeObjectDetailsProps Type parameters # Name Type Kube extends KubeObject = KubeObject Table of contents # Properties # className object Properties # className # \u2022 Optional className : string object # \u2022 object : Kube","title":"Interface: KubeObjectDetailsProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#interface-kubeobjectdetailspropskube","text":"Renderer . Component .KubeObjectDetailsProps","title":"Interface: KubeObjectDetailsProps<Kube>"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#type-parameters","text":"Name Type Kube extends KubeObject = KubeObject","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#properties","text":"className object","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#object","text":"\u2022 object : Kube","title":"object"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/","text":"Interface: KubeObjectListLayoutProps # Renderer . Component .KubeObjectListLayoutProps Type parameters # Name Type K extends KubeObject A extends KubeApi < K , D > D extends KubeJsonApiDataFor < K > Hierarchy # Omit < ItemListLayoutProps < K , false >, \"getItems\" | \"dependentStores\" | \"preloadStores\" > \u21b3 KubeObjectListLayoutProps Table of contents # Properties # addRemoveButtons className copyClassNameFromHeadCells customizeHeader customizeRemoveDialog customizeTableRowProps data-testid dependentStores detailsItem failedToLoadMessage filterCallbacks filterItems getItems hasDetailsView headerClassName hideFilters isConfigurable isReady isSelectable items onDetails renderFooter renderHeaderTitle renderItemMenu renderTableContents renderTableHeader resourceName searchFilters showHeader sortingCallbacks spinnerTestId store subscribeStores tableId tableProps virtual Properties # addRemoveButtons # \u2022 Optional addRemoveButtons : Partial < AddRemoveButtonsProps > Inherited from # Omit.addRemoveButtons className # \u2022 className : IClassName Inherited from # Omit.className copyClassNameFromHeadCells # \u2022 Optional copyClassNameFromHeadCells : boolean Inherited from # Omit.copyClassNameFromHeadCells customizeHeader # \u2022 Optional customizeHeader : HeaderCustomizer | HeaderCustomizer [] Inherited from # Omit.customizeHeader customizeRemoveDialog # \u2022 Optional customizeRemoveDialog : ( selectedItems : K []) => Partial < ConfirmDialogParams > Type declaration # \u25b8 ( selectedItems ): Partial < ConfirmDialogParams > Parameters # Name Type selectedItems K [] Returns # Partial < ConfirmDialogParams > Inherited from # Omit.customizeRemoveDialog customizeTableRowProps # \u2022 Optional customizeTableRowProps : ( item : K ) => Partial < TableRowProps < K >> Type declaration # \u25b8 ( item ): Partial < TableRowProps < K >> Parameters # Name Type item K Returns # Partial < TableRowProps < K >> Inherited from # Omit.customizeTableRowProps data-testid # \u2022 Optional data-testid : string Inherited from # Omit.data-testid dependentStores # \u2022 Optional dependentStores : SubscribableStore [] detailsItem # \u2022 Optional detailsItem : K Inherited from # Omit.detailsItem failedToLoadMessage # \u2022 Optional failedToLoadMessage : ReactNode Message to display when a store failed to load Default \"Failed to load items\" Inherited from # Omit.failedToLoadMessage filterCallbacks # \u2022 Optional filterCallbacks : ItemsFilters < K > Inherited from # Omit.filterCallbacks filterItems # \u2022 Optional filterItems : ItemsFilter < K >[] Deprecated Inherited from # Omit.filterItems getItems # \u2022 Optional getItems : () => K [] Type declaration # \u25b8 (): K [] Returns # K [] hasDetailsView # \u2022 Optional hasDetailsView : boolean Inherited from # Omit.hasDetailsView headerClassName # \u2022 Optional headerClassName : IClassName Inherited from # Omit.headerClassName hideFilters # \u2022 Optional hideFilters : boolean Inherited from # Omit.hideFilters isConfigurable # \u2022 Optional isConfigurable : boolean Inherited from # Omit.isConfigurable isReady # \u2022 Optional isReady : boolean Inherited from # Omit.isReady isSelectable # \u2022 Optional isSelectable : boolean Inherited from # Omit.isSelectable items # \u2022 Optional items : K [] onDetails # \u2022 Optional onDetails : ( item : K ) => void Type declaration # \u25b8 ( item ): void Parameters # Name Type item K Returns # void Inherited from # Omit.onDetails renderFooter # \u2022 Optional renderFooter : ( parent : NonInjectedItemListLayout < K , false >) => ReactNode Type declaration # \u25b8 ( parent ): ReactNode Parameters # Name Type parent NonInjectedItemListLayout < K , false > Returns # ReactNode Inherited from # Omit.renderFooter renderHeaderTitle # \u2022 Optional renderHeaderTitle : RenderHeaderTitle < K , false > Inherited from # Omit.renderHeaderTitle renderItemMenu # \u2022 Optional renderItemMenu : ( item : K , store : ItemListStore < K , false >) => ReactNode Type declaration # \u25b8 ( item , store ): ReactNode Parameters # Name Type item K store ItemListStore < K , false > Returns # ReactNode Inherited from # Omit.renderItemMenu renderTableContents # \u2022 renderTableContents : ( item : K ) => ( ReactNode | TableCellProps )[] Type declaration # \u25b8 ( item ): ( ReactNode | TableCellProps )[] Parameters # Name Type item K Returns # ( ReactNode | TableCellProps )[] Inherited from # Omit.renderTableContents renderTableHeader # \u2022 Optional renderTableHeader : ( undefined | null | TableCellProps )[] Inherited from # Omit.renderTableHeader resourceName # \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. searchFilters # \u2022 Optional searchFilters : SearchFilter < K >[] Inherited from # Omit.searchFilters showHeader # \u2022 Optional showHeader : boolean Inherited from # Omit.showHeader sortingCallbacks # \u2022 Optional sortingCallbacks : TableSortCallbacks < K > Inherited from # Omit.sortingCallbacks spinnerTestId # \u2022 Optional spinnerTestId : string Inherited from # Omit.spinnerTestId store # \u2022 store : KubeObjectStore < K , A , D > Overrides # Omit.store subscribeStores # \u2022 Optional subscribeStores : boolean tableId # \u2022 Optional tableId : string Inherited from # Omit.tableId tableProps # \u2022 Optional tableProps : Partial < TableProps < K >> Inherited from # Omit.tableProps virtual # \u2022 Optional virtual : boolean Inherited from # Omit.virtual","title":"Interface: KubeObjectListLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#interface-kubeobjectlistlayoutpropsk-a-d","text":"Renderer . Component .KubeObjectListLayoutProps","title":"Interface: KubeObjectListLayoutProps<K, A, D>"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-parameters","text":"Name Type K extends KubeObject A extends KubeApi < K , D > D extends KubeJsonApiDataFor < K >","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#hierarchy","text":"Omit < ItemListLayoutProps < K , false >, \"getItems\" | \"dependentStores\" | \"preloadStores\" > \u21b3 KubeObjectListLayoutProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#properties","text":"addRemoveButtons className copyClassNameFromHeadCells customizeHeader customizeRemoveDialog customizeTableRowProps data-testid dependentStores detailsItem failedToLoadMessage filterCallbacks filterItems getItems hasDetailsView headerClassName hideFilters isConfigurable isReady isSelectable items onDetails renderFooter renderHeaderTitle renderItemMenu renderTableContents renderTableHeader resourceName searchFilters showHeader sortingCallbacks spinnerTestId store subscribeStores tableId tableProps virtual","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#addremovebuttons","text":"\u2022 Optional addRemoveButtons : Partial < AddRemoveButtonsProps >","title":"addRemoveButtons"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#classname","text":"\u2022 className : IClassName","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#copyclassnamefromheadcells","text":"\u2022 Optional copyClassNameFromHeadCells : boolean","title":"copyClassNameFromHeadCells"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#customizeheader","text":"\u2022 Optional customizeHeader : HeaderCustomizer | HeaderCustomizer []","title":"customizeHeader"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#customizeremovedialog","text":"\u2022 Optional customizeRemoveDialog : ( selectedItems : K []) => Partial < ConfirmDialogParams >","title":"customizeRemoveDialog"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#customizetablerowprops","text":"\u2022 Optional customizeTableRowProps : ( item : K ) => Partial < TableRowProps < K >>","title":"customizeTableRowProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#dependentstores","text":"\u2022 Optional dependentStores : SubscribableStore []","title":"dependentStores"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#detailsitem","text":"\u2022 Optional detailsItem : K","title":"detailsItem"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#failedtoloadmessage","text":"\u2022 Optional failedToLoadMessage : ReactNode Message to display when a store failed to load Default \"Failed to load items\"","title":"failedToLoadMessage"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#filtercallbacks","text":"\u2022 Optional filterCallbacks : ItemsFilters < K >","title":"filterCallbacks"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#filteritems","text":"\u2022 Optional filterItems : ItemsFilter < K >[] Deprecated","title":"filterItems"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#getitems","text":"\u2022 Optional getItems : () => K []","title":"getItems"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#hasdetailsview","text":"\u2022 Optional hasDetailsView : boolean","title":"hasDetailsView"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#headerclassname","text":"\u2022 Optional headerClassName : IClassName","title":"headerClassName"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#hidefilters","text":"\u2022 Optional hideFilters : boolean","title":"hideFilters"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#isconfigurable","text":"\u2022 Optional isConfigurable : boolean","title":"isConfigurable"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#isready","text":"\u2022 Optional isReady : boolean","title":"isReady"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#isselectable","text":"\u2022 Optional isSelectable : boolean","title":"isSelectable"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#items","text":"\u2022 Optional items : K []","title":"items"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#ondetails","text":"\u2022 Optional onDetails : ( item : K ) => void","title":"onDetails"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#renderfooter","text":"\u2022 Optional renderFooter : ( parent : NonInjectedItemListLayout < K , false >) => ReactNode","title":"renderFooter"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#renderheadertitle","text":"\u2022 Optional renderHeaderTitle : RenderHeaderTitle < K , false >","title":"renderHeaderTitle"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#renderitemmenu","text":"\u2022 Optional renderItemMenu : ( item : K , store : ItemListStore < K , false >) => ReactNode","title":"renderItemMenu"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#rendertablecontents","text":"\u2022 renderTableContents : ( item : K ) => ( ReactNode | TableCellProps )[]","title":"renderTableContents"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#rendertableheader","text":"\u2022 Optional renderTableHeader : ( undefined | null | TableCellProps )[]","title":"renderTableHeader"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#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.","title":"resourceName"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#searchfilters","text":"\u2022 Optional searchFilters : SearchFilter < K >[]","title":"searchFilters"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#showheader","text":"\u2022 Optional showHeader : boolean","title":"showHeader"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#sortingcallbacks","text":"\u2022 Optional sortingCallbacks : TableSortCallbacks < K >","title":"sortingCallbacks"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#spinnertestid","text":"\u2022 Optional spinnerTestId : string","title":"spinnerTestId"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#store","text":"\u2022 store : KubeObjectStore < K , A , D >","title":"store"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#subscribestores","text":"\u2022 Optional subscribeStores : boolean","title":"subscribeStores"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#tableid","text":"\u2022 Optional tableId : string","title":"tableId"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#tableprops","text":"\u2022 Optional tableProps : Partial < TableProps < K >>","title":"tableProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#virtual","text":"\u2022 Optional virtual : boolean","title":"virtual"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/","text":"Interface: KubeObjectMenuProps # Renderer . Component .KubeObjectMenuProps Type parameters # Name Type TKubeObject extends KubeObject Hierarchy # MenuActionsProps \u21b3 KubeObjectMenuProps Table of contents # Properties # animated autoCloseOnSelect autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll data-testid editable htmlFor id isOpen object onOpen position removable removeAction removeConfirmationMessage toggleEvent toolbar triggerIcon updateAction usePortal Methods # close open Properties # animated # \u2022 Optional animated : boolean Inherited from # MenuActionsProps . animated autoCloseOnSelect # \u2022 Optional autoCloseOnSelect : boolean Inherited from # MenuActionsProps . autoCloseOnSelect autoFocus # \u2022 Optional autoFocus : boolean Inherited from # MenuActionsProps . autoFocus children # \u2022 Optional children : ReactNode Inherited from # MenuActionsProps . children className # \u2022 Optional className : string Inherited from # MenuActionsProps . className closeOnClickItem # \u2022 Optional closeOnClickItem : boolean Inherited from # MenuActionsProps . closeOnClickItem closeOnClickOutside # \u2022 Optional closeOnClickOutside : boolean Inherited from # MenuActionsProps . closeOnClickOutside closeOnScroll # \u2022 Optional closeOnScroll : boolean Inherited from # MenuActionsProps . closeOnScroll data-testid # \u2022 Optional data-testid : string Inherited from # MenuActionsProps . data-testid editable # \u2022 Optional editable : boolean htmlFor # \u2022 Optional htmlFor : string Inherited from # MenuActionsProps . htmlFor id # \u2022 Optional id : string Inherited from # MenuActionsProps . id isOpen # \u2022 Optional isOpen : boolean Inherited from # MenuActionsProps . isOpen object # \u2022 object : TKubeObject onOpen # \u2022 Optional onOpen : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # MenuActionsProps . onOpen position # \u2022 Optional position : MenuPosition Inherited from # MenuActionsProps . position removable # \u2022 Optional removable : boolean removeAction # \u2022 Optional removeAction : () => void | Promise < void > Type declaration # \u25b8 (): void | Promise < void > Deprecated Provide your own remove as part of the children passed to this component Returns # void | Promise < void > Inherited from # MenuActionsProps . removeAction removeConfirmationMessage # \u2022 Optional removeConfirmationMessage : ReactNode | () => ReactNode Deprecated Provide your own remove as part of the children passed to this component Inherited from # MenuActionsProps . removeConfirmationMessage toggleEvent # \u2022 Optional toggleEvent : \"click\" | \"contextmenu\" Inherited from # MenuActionsProps . toggleEvent toolbar # \u2022 Optional toolbar : boolean Inherited from # MenuActionsProps . toolbar triggerIcon # \u2022 Optional triggerIcon : ReactNode | IconProps & TooltipDecoratorProps Inherited from # MenuActionsProps . triggerIcon updateAction # \u2022 Optional updateAction : () => void | Promise < void > Type declaration # \u25b8 (): void | Promise < void > Deprecated Provide your own update as part of the children passed to this component Returns # void | Promise < void > Inherited from # MenuActionsProps . updateAction usePortal # \u2022 Optional usePortal : boolean | HTMLElement Inherited from # MenuActionsProps . usePortal Methods # close # \u25b8 Optional close (): void Returns # void Inherited from # MenuActionsProps . close open # \u25b8 Optional open (): void Returns # void Inherited from # MenuActionsProps . open","title":"Interface: KubeObjectMenuProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#interface-kubeobjectmenupropstkubeobject","text":"Renderer . Component .KubeObjectMenuProps","title":"Interface: KubeObjectMenuProps<TKubeObject>"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#type-parameters","text":"Name Type TKubeObject extends KubeObject","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#hierarchy","text":"MenuActionsProps \u21b3 KubeObjectMenuProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#properties","text":"animated autoCloseOnSelect autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll data-testid editable htmlFor id isOpen object onOpen position removable removeAction removeConfirmationMessage toggleEvent toolbar triggerIcon updateAction usePortal","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#methods","text":"close open","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#animated","text":"\u2022 Optional animated : boolean","title":"animated"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#autocloseonselect","text":"\u2022 Optional autoCloseOnSelect : boolean","title":"autoCloseOnSelect"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#closeonclickitem","text":"\u2022 Optional closeOnClickItem : boolean","title":"closeOnClickItem"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#closeonclickoutside","text":"\u2022 Optional closeOnClickOutside : boolean","title":"closeOnClickOutside"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#closeonscroll","text":"\u2022 Optional closeOnScroll : boolean","title":"closeOnScroll"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#editable","text":"\u2022 Optional editable : boolean","title":"editable"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#htmlfor","text":"\u2022 Optional htmlFor : string","title":"htmlFor"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#isopen","text":"\u2022 Optional isOpen : boolean","title":"isOpen"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#object","text":"\u2022 object : TKubeObject","title":"object"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#onopen","text":"\u2022 Optional onOpen : () => void","title":"onOpen"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#position","text":"\u2022 Optional position : MenuPosition","title":"position"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#removable","text":"\u2022 Optional removable : boolean","title":"removable"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#removeaction","text":"\u2022 Optional removeAction : () => void | Promise < void >","title":"removeAction"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#removeconfirmationmessage","text":"\u2022 Optional removeConfirmationMessage : ReactNode | () => ReactNode Deprecated Provide your own remove as part of the children passed to this component","title":"removeConfirmationMessage"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#toggleevent","text":"\u2022 Optional toggleEvent : \"click\" | \"contextmenu\"","title":"toggleEvent"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#toolbar","text":"\u2022 Optional toolbar : boolean","title":"toolbar"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#triggericon","text":"\u2022 Optional triggerIcon : ReactNode | IconProps & TooltipDecoratorProps","title":"triggerIcon"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#updateaction","text":"\u2022 Optional updateAction : () => void | Promise < void >","title":"updateAction"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#useportal","text":"\u2022 Optional usePortal : boolean | HTMLElement","title":"usePortal"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#close","text":"\u25b8 Optional close (): void","title":"close"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#open","text":"\u25b8 Optional open (): void","title":"open"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/","text":"Interface: KubeObjectMetaProps # Renderer . Component .KubeObjectMetaProps Table of contents # Properties # hideFields object Properties # hideFields # \u2022 Optional hideFields : keyof BaseKubeJsonApiObjectMetadata < KubeObjectScope >[] object # \u2022 object : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >","title":"Interface: KubeObjectMetaProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#interface-kubeobjectmetaprops","text":"Renderer . Component .KubeObjectMetaProps","title":"Interface: KubeObjectMetaProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#properties","text":"hideFields object","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#hidefields","text":"\u2022 Optional hideFields : keyof BaseKubeJsonApiObjectMetadata < KubeObjectScope >[]","title":"hideFields"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#object","text":"\u2022 object : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >","title":"object"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/","text":"Interface: LineProgressProps # Renderer . Component .LineProgressProps Hierarchy # HTMLProps < HTMLDivElement > \u21b3 LineProgressProps Table of contents # Properties # className max min precise value Properties # className # \u2022 Optional className : any Overrides # React.HTMLProps.className max # \u2022 Optional max : number Overrides # React.HTMLProps.max min # \u2022 Optional min : number Overrides # React.HTMLProps.min precise # \u2022 Optional precise : number value # \u2022 value : number Overrides # React.HTMLProps.value","title":"Interface: LineProgressProps"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#interface-lineprogressprops","text":"Renderer . Component .LineProgressProps","title":"Interface: LineProgressProps"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#hierarchy","text":"HTMLProps < HTMLDivElement > \u21b3 LineProgressProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#properties","text":"className max min precise value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#classname","text":"\u2022 Optional className : any","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#max","text":"\u2022 Optional max : number","title":"max"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#min","text":"\u2022 Optional min : number","title":"min"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#precise","text":"\u2022 Optional precise : number","title":"precise"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#value","text":"\u2022 value : number","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/","text":"Interface: MainLayoutProps # Renderer . Component .MainLayoutProps Table of contents # Properties # children className footer sidebar Properties # children # \u2022 Optional children : ReactNode | ReactNode [] className # \u2022 Optional className : string footer # \u2022 Optional footer : ReactNode sidebar # \u2022 sidebar : ReactNode","title":"Interface: MainLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#interface-mainlayoutprops","text":"Renderer . Component .MainLayoutProps","title":"Interface: MainLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#properties","text":"children className footer sidebar","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#children","text":"\u2022 Optional children : ReactNode | ReactNode []","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#footer","text":"\u2022 Optional footer : ReactNode","title":"footer"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#sidebar","text":"\u2022 sidebar : ReactNode","title":"sidebar"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/","text":"Interface: MenuActionsProps # Renderer . Component .MenuActionsProps Hierarchy # Partial < MenuProps > \u21b3 MenuActionsProps \u21b3\u21b3 KubeObjectMenuProps Table of contents # Properties # animated autoCloseOnSelect autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll data-testid htmlFor id isOpen onOpen position removeAction removeConfirmationMessage toggleEvent toolbar triggerIcon updateAction usePortal Methods # close open Properties # animated # \u2022 Optional animated : boolean Inherited from # Partial.animated autoCloseOnSelect # \u2022 Optional autoCloseOnSelect : boolean autoFocus # \u2022 Optional autoFocus : boolean Inherited from # Partial.autoFocus children # \u2022 Optional children : ReactNode Inherited from # Partial.children className # \u2022 Optional className : string Overrides # Partial.className closeOnClickItem # \u2022 Optional closeOnClickItem : boolean Inherited from # Partial.closeOnClickItem closeOnClickOutside # \u2022 Optional closeOnClickOutside : boolean Inherited from # Partial.closeOnClickOutside closeOnScroll # \u2022 Optional closeOnScroll : boolean Inherited from # Partial.closeOnScroll data-testid # \u2022 Optional data-testid : string Inherited from # Partial.data-testid htmlFor # \u2022 Optional htmlFor : string Inherited from # Partial.htmlFor id # \u2022 Optional id : string Overrides # Partial.id isOpen # \u2022 Optional isOpen : boolean Inherited from # Partial.isOpen onOpen # \u2022 Optional onOpen : () => void Type declaration # \u25b8 (): void Returns # void position # \u2022 Optional position : MenuPosition Inherited from # Partial.position removeAction # \u2022 Optional removeAction : () => void | Promise < void > Type declaration # \u25b8 (): void | Promise < void > Deprecated Provide your own remove as part of the children passed to this component Returns # void | Promise < void > removeConfirmationMessage # \u2022 Optional removeConfirmationMessage : ReactNode | () => ReactNode Deprecated Provide your own remove as part of the children passed to this component toggleEvent # \u2022 Optional toggleEvent : \"click\" | \"contextmenu\" Inherited from # Partial.toggleEvent toolbar # \u2022 Optional toolbar : boolean triggerIcon # \u2022 Optional triggerIcon : ReactNode | IconProps & TooltipDecoratorProps updateAction # \u2022 Optional updateAction : () => void | Promise < void > Type declaration # \u25b8 (): void | Promise < void > Deprecated Provide your own update as part of the children passed to this component Returns # void | Promise < void > usePortal # \u2022 Optional usePortal : boolean | HTMLElement Inherited from # Partial.usePortal Methods # close # \u25b8 Optional close (): void Returns # void Inherited from # Partial.close open # \u25b8 Optional open (): void Returns # void Inherited from # Partial.open","title":"Interface: MenuActionsProps"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#interface-menuactionsprops","text":"Renderer . Component .MenuActionsProps","title":"Interface: MenuActionsProps"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#hierarchy","text":"Partial < MenuProps > \u21b3 MenuActionsProps \u21b3\u21b3 KubeObjectMenuProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#properties","text":"animated autoCloseOnSelect autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll data-testid htmlFor id isOpen onOpen position removeAction removeConfirmationMessage toggleEvent toolbar triggerIcon updateAction usePortal","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#methods","text":"close open","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#animated","text":"\u2022 Optional animated : boolean","title":"animated"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#autocloseonselect","text":"\u2022 Optional autoCloseOnSelect : boolean","title":"autoCloseOnSelect"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#closeonclickitem","text":"\u2022 Optional closeOnClickItem : boolean","title":"closeOnClickItem"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#closeonclickoutside","text":"\u2022 Optional closeOnClickOutside : boolean","title":"closeOnClickOutside"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#closeonscroll","text":"\u2022 Optional closeOnScroll : boolean","title":"closeOnScroll"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#htmlfor","text":"\u2022 Optional htmlFor : string","title":"htmlFor"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#isopen","text":"\u2022 Optional isOpen : boolean","title":"isOpen"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#onopen","text":"\u2022 Optional onOpen : () => void","title":"onOpen"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#position","text":"\u2022 Optional position : MenuPosition","title":"position"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#removeaction","text":"\u2022 Optional removeAction : () => void | Promise < void >","title":"removeAction"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#removeconfirmationmessage","text":"\u2022 Optional removeConfirmationMessage : ReactNode | () => ReactNode Deprecated Provide your own remove as part of the children passed to this component","title":"removeConfirmationMessage"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#toggleevent","text":"\u2022 Optional toggleEvent : \"click\" | \"contextmenu\"","title":"toggleEvent"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#toolbar","text":"\u2022 Optional toolbar : boolean","title":"toolbar"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#triggericon","text":"\u2022 Optional triggerIcon : ReactNode | IconProps & TooltipDecoratorProps","title":"triggerIcon"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#updateaction","text":"\u2022 Optional updateAction : () => void | Promise < void >","title":"updateAction"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#useportal","text":"\u2022 Optional usePortal : boolean | HTMLElement","title":"usePortal"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#close","text":"\u25b8 Optional close (): void","title":"close"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#open","text":"\u25b8 Optional open (): void","title":"open"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/","text":"Interface: MenuContextValue # Renderer . Component .MenuContextValue Table of contents # Properties # close props Properties # close # \u2022 close : () => void Type declaration # \u25b8 (): void Returns # void props # \u2022 Readonly props : Readonly < MenuProps >","title":"Interface: MenuContextValue"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#interface-menucontextvalue","text":"Renderer . Component .MenuContextValue","title":"Interface: MenuContextValue"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#properties","text":"close props","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#close","text":"\u2022 close : () => void","title":"close"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#props","text":"\u2022 Readonly props : Readonly < MenuProps >","title":"props"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/","text":"Interface: MenuItemProps # Renderer . Component .MenuItemProps Hierarchy # HTMLProps < any > \u21b3 MenuItemProps Table of contents # Properties # active disabled href icon spacer Properties # active # \u2022 Optional active : boolean disabled # \u2022 Optional disabled : boolean Overrides # React.HTMLProps.disabled href # \u2022 Optional href : string Overrides # React.HTMLProps.href icon # \u2022 Optional icon : string | Partial < IconProps > spacer # \u2022 Optional spacer : boolean","title":"Interface: MenuItemProps"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#interface-menuitemprops","text":"Renderer . Component .MenuItemProps","title":"Interface: MenuItemProps"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#hierarchy","text":"HTMLProps < any > \u21b3 MenuItemProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#properties","text":"active disabled href icon spacer","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#href","text":"\u2022 Optional href : string","title":"href"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#icon","text":"\u2022 Optional icon : string | Partial < IconProps >","title":"icon"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#spacer","text":"\u2022 Optional spacer : boolean","title":"spacer"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/","text":"Interface: MenuPosition # Renderer . Component .MenuPosition Table of contents # Properties # bottom left right top Properties # bottom # \u2022 Optional bottom : boolean left # \u2022 Optional left : boolean right # \u2022 Optional right : boolean top # \u2022 Optional top : boolean","title":"Interface: MenuPosition"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#interface-menuposition","text":"Renderer . Component .MenuPosition","title":"Interface: MenuPosition"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#properties","text":"bottom left right top","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#bottom","text":"\u2022 Optional bottom : boolean","title":"bottom"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#left","text":"\u2022 Optional left : boolean","title":"left"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#right","text":"\u2022 Optional right : boolean","title":"right"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#top","text":"\u2022 Optional top : boolean","title":"top"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/","text":"Interface: MenuProps # Renderer . Component .MenuProps Table of contents # Properties # animated autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll data-testid htmlFor id isOpen position toggleEvent usePortal Methods # close open Properties # animated # \u2022 Optional animated : boolean autoFocus # \u2022 Optional autoFocus : boolean children # \u2022 Optional children : ReactNode className # \u2022 Optional className : string closeOnClickItem # \u2022 Optional closeOnClickItem : boolean closeOnClickOutside # \u2022 Optional closeOnClickOutside : boolean closeOnScroll # \u2022 Optional closeOnScroll : boolean data-testid # \u2022 Optional data-testid : string htmlFor # \u2022 Optional htmlFor : string id # \u2022 Optional id : string isOpen # \u2022 Optional isOpen : boolean position # \u2022 Optional position : MenuPosition toggleEvent # \u2022 Optional toggleEvent : \"click\" | \"contextmenu\" usePortal # \u2022 Optional usePortal : boolean | HTMLElement Methods # close # \u25b8 close (): void Returns # void open # \u25b8 open (): void Returns # void","title":"Interface: MenuProps"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#interface-menuprops","text":"Renderer . Component .MenuProps","title":"Interface: MenuProps"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#properties","text":"animated autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll data-testid htmlFor id isOpen position toggleEvent usePortal","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#methods","text":"close open","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#animated","text":"\u2022 Optional animated : boolean","title":"animated"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#closeonclickitem","text":"\u2022 Optional closeOnClickItem : boolean","title":"closeOnClickItem"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#closeonclickoutside","text":"\u2022 Optional closeOnClickOutside : boolean","title":"closeOnClickOutside"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#closeonscroll","text":"\u2022 Optional closeOnScroll : boolean","title":"closeOnScroll"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#htmlfor","text":"\u2022 Optional htmlFor : string","title":"htmlFor"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#isopen","text":"\u2022 Optional isOpen : boolean","title":"isOpen"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#position","text":"\u2022 Optional position : MenuPosition","title":"position"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#toggleevent","text":"\u2022 Optional toggleEvent : \"click\" | \"contextmenu\"","title":"toggleEvent"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#useportal","text":"\u2022 Optional usePortal : boolean | HTMLElement","title":"usePortal"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#close","text":"\u25b8 close (): void","title":"close"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#open","text":"\u25b8 open (): void","title":"open"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/","text":"Interface: MenuStyle # Renderer . Component .MenuStyle Table of contents # Properties # left top Properties # left # \u2022 left : string top # \u2022 top : string","title":"Interface: MenuStyle"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#interface-menustyle","text":"Renderer . Component .MenuStyle","title":"Interface: MenuStyle"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#properties","text":"left top","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#left","text":"\u2022 left : string","title":"left"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#top","text":"\u2022 top : string","title":"top"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/","text":"Interface: MonacoEditorProps # Renderer . Component .MonacoEditorProps Table of contents # Properties # autoFocus className id innerRef language options readOnly setInitialHeight style theme value Methods # onChange onDidContentSizeChange onDidLayoutChange onError onModelChange Properties # autoFocus # \u2022 Optional autoFocus : boolean className # \u2022 Optional className : string id # \u2022 Optional id : string innerRef # \u2022 Optional innerRef : ForwardedRef < MonacoEditorRef > language # \u2022 Optional language : \"yaml\" | \"json\" options # \u2022 Optional options : Partial < IStandaloneEditorConstructionOptions > readOnly # \u2022 Optional readOnly : boolean setInitialHeight # \u2022 Optional setInitialHeight : boolean style # \u2022 Optional style : CSSProperties theme # \u2022 Optional theme : MonacoTheme value # \u2022 value : string Methods # onChange # \u25b8 Optional onChange ( value , evt ): void Parameters # Name Type value string evt IModelContentChangedEvent Returns # void onDidContentSizeChange # \u25b8 Optional onDidContentSizeChange ( evt ): void Parameters # Name Type evt IContentSizeChangedEvent Returns # void onDidLayoutChange # \u25b8 Optional onDidLayoutChange ( info ): void Parameters # Name Type info EditorLayoutInfo Returns # void onError # \u25b8 Optional onError ( error ): void Parameters # Name Type error unknown Returns # void onModelChange # \u25b8 Optional onModelChange ( model , prev? ): void Parameters # Name Type model ITextModel prev? ITextModel Returns # void","title":"Interface: MonacoEditorProps"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#interface-monacoeditorprops","text":"Renderer . Component .MonacoEditorProps","title":"Interface: MonacoEditorProps"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#properties","text":"autoFocus className id innerRef language options readOnly setInitialHeight style theme value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#methods","text":"onChange onDidContentSizeChange onDidLayoutChange onError onModelChange","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#innerref","text":"\u2022 Optional innerRef : ForwardedRef < MonacoEditorRef >","title":"innerRef"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#language","text":"\u2022 Optional language : \"yaml\" | \"json\"","title":"language"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#options","text":"\u2022 Optional options : Partial < IStandaloneEditorConstructionOptions >","title":"options"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#readonly","text":"\u2022 Optional readOnly : boolean","title":"readOnly"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#setinitialheight","text":"\u2022 Optional setInitialHeight : boolean","title":"setInitialHeight"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#theme","text":"\u2022 Optional theme : MonacoTheme","title":"theme"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#value","text":"\u2022 value : string","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#onchange","text":"\u25b8 Optional onChange ( value , evt ): void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#ondidcontentsizechange","text":"\u25b8 Optional onDidContentSizeChange ( evt ): void","title":"onDidContentSizeChange"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#ondidlayoutchange","text":"\u25b8 Optional onDidLayoutChange ( info ): void","title":"onDidLayoutChange"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#onerror","text":"\u25b8 Optional onError ( error ): void","title":"onError"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#onmodelchange","text":"\u25b8 Optional onModelChange ( model , prev? ): void","title":"onModelChange"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/","text":"Interface: NamespaceSelectProps # Renderer . Component .NamespaceSelectProps Type parameters # Name Type IsMulti extends boolean Hierarchy # Omit < SelectProps < string , { label : string ; value : string }, IsMulti >, \"options\" | \"value\" > \u21b3 NamespaceSelectProps Table of contents # Properties # autoConvertOptions id isCreatable menuClass showIcons sort themeName value Properties # autoConvertOptions # \u2022 Optional autoConvertOptions : boolean Deprecated We will always auto convert options if they are of type string Inherited from # Omit.autoConvertOptions id # \u2022 Optional id : string Inherited from # Omit.id isCreatable # \u2022 Optional isCreatable : boolean Deprecated This option does nothing Inherited from # Omit.isCreatable menuClass # \u2022 Optional menuClass : string Inherited from # Omit.menuClass showIcons # \u2022 Optional showIcons : boolean sort # \u2022 Optional sort : NamespaceSelectSort themeName # \u2022 Optional themeName : \"dark\" | \"light\" | \"outlined\" | \"lens\" Inherited from # Omit.themeName value # \u2022 value : undefined | null | string","title":"Interface: NamespaceSelectProps"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#interface-namespaceselectpropsismulti","text":"Renderer . Component .NamespaceSelectProps","title":"Interface: NamespaceSelectProps<IsMulti>"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#type-parameters","text":"Name Type IsMulti extends boolean","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#hierarchy","text":"Omit < SelectProps < string , { label : string ; value : string }, IsMulti >, \"options\" | \"value\" > \u21b3 NamespaceSelectProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#properties","text":"autoConvertOptions id isCreatable menuClass showIcons sort themeName value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#autoconvertoptions","text":"\u2022 Optional autoConvertOptions : boolean Deprecated We will always auto convert options if they are of type string","title":"autoConvertOptions"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#iscreatable","text":"\u2022 Optional isCreatable : boolean Deprecated This option does nothing","title":"isCreatable"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#menuclass","text":"\u2022 Optional menuClass : string","title":"menuClass"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#showicons","text":"\u2022 Optional showIcons : boolean","title":"showIcons"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#sort","text":"\u2022 Optional sort : NamespaceSelectSort","title":"sort"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#themename","text":"\u2022 Optional themeName : \"dark\" | \"light\" | \"outlined\" | \"lens\"","title":"themeName"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#value","text":"\u2022 value : undefined | null | string","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/","text":"Interface: Notification # Renderer . Component .Notification Table of contents # Properties # id message status timeout Methods # onClose Properties # id # \u2022 Optional id : NotificationId message # \u2022 message : NotificationMessage status # \u2022 Optional status : NotificationStatus timeout # \u2022 Optional timeout : number Methods # onClose # \u25b8 Optional onClose (): void Returns # void","title":"Interface: Notification"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#interface-notification","text":"Renderer . Component .Notification","title":"Interface: Notification"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#properties","text":"id message status timeout","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#methods","text":"onClose","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#id","text":"\u2022 Optional id : NotificationId","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#message","text":"\u2022 message : NotificationMessage","title":"message"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#status","text":"\u2022 Optional status : NotificationStatus","title":"status"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#timeout","text":"\u2022 Optional timeout : number","title":"timeout"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#onclose","text":"\u25b8 Optional onClose (): void","title":"onClose"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/","text":"Interface: PieChartData # Renderer . Component .PieChartData Hierarchy # ChartData \u21b3 PieChartData Table of contents # Properties # datasets Properties # datasets # \u2022 Optional datasets : PieChartDataSets [] Overrides # ChartJS.ChartData.datasets","title":"Interface: PieChartData"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#interface-piechartdata","text":"Renderer . Component .PieChartData","title":"Interface: PieChartData"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#hierarchy","text":"ChartData \u21b3 PieChartData","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#properties","text":"datasets","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#datasets","text":"\u2022 Optional datasets : PieChartDataSets []","title":"datasets"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/","text":"Interface: PieChartProps # Renderer . Component .PieChartProps Hierarchy # ChartProps \u21b3 PieChartProps Table of contents # Properties # className data data-testid height legendColors legendPosition options plugins redraw showChart showLegend title type width Properties # className # \u2022 Optional className : string Inherited from # ChartProps.className data # \u2022 data : ChartData Inherited from # ChartProps.data data-testid # \u2022 Optional data-testid : string Inherited from # ChartProps.data-testid height # \u2022 Optional height : string | number Inherited from # ChartProps.height legendColors # \u2022 Optional legendColors : string [] Inherited from # ChartProps.legendColors legendPosition # \u2022 Optional legendPosition : \"bottom\" Inherited from # ChartProps.legendPosition options # \u2022 Optional options : ChartOptions Inherited from # ChartProps.options plugins # \u2022 Optional plugins : PluginServiceRegistrationOptions [] Inherited from # ChartProps.plugins redraw # \u2022 Optional redraw : boolean Inherited from # ChartProps.redraw showChart # \u2022 Optional showChart : boolean Inherited from # ChartProps.showChart showLegend # \u2022 Optional showLegend : boolean Inherited from # ChartProps.showLegend title # \u2022 Optional title : string Inherited from # ChartProps.title type # \u2022 Optional type : ChartKind Inherited from # ChartProps.type width # \u2022 Optional width : string | number Inherited from # ChartProps.width","title":"Interface: PieChartProps"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#interface-piechartprops","text":"Renderer . Component .PieChartProps","title":"Interface: PieChartProps"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#hierarchy","text":"ChartProps \u21b3 PieChartProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#properties","text":"className data data-testid height legendColors legendPosition options plugins redraw showChart showLegend title type width","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#data","text":"\u2022 data : ChartData","title":"data"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#height","text":"\u2022 Optional height : string | number","title":"height"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#legendcolors","text":"\u2022 Optional legendColors : string []","title":"legendColors"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#legendposition","text":"\u2022 Optional legendPosition : \"bottom\"","title":"legendPosition"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#options","text":"\u2022 Optional options : ChartOptions","title":"options"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#plugins","text":"\u2022 Optional plugins : PluginServiceRegistrationOptions []","title":"plugins"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#redraw","text":"\u2022 Optional redraw : boolean","title":"redraw"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#showchart","text":"\u2022 Optional showChart : boolean","title":"showChart"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#showlegend","text":"\u2022 Optional showLegend : boolean","title":"showLegend"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#type","text":"\u2022 Optional type : ChartKind","title":"type"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#width","text":"\u2022 Optional width : string | number","title":"width"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/","text":"Interface: PodDetailsListProps # Renderer . Component .PodDetailsListProps Table of contents # Properties # maxCpu maxMemory owner pods Properties # maxCpu # \u2022 Optional maxCpu : number maxMemory # \u2022 Optional maxMemory : number owner # \u2022 owner : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > pods # \u2022 pods : Pod []","title":"Interface: PodDetailsListProps"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#interface-poddetailslistprops","text":"Renderer . Component .PodDetailsListProps","title":"Interface: PodDetailsListProps"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#properties","text":"maxCpu maxMemory owner pods","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#maxcpu","text":"\u2022 Optional maxCpu : number","title":"maxCpu"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#maxmemory","text":"\u2022 Optional maxMemory : number","title":"maxMemory"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#owner","text":"\u2022 owner : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >","title":"owner"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#pods","text":"\u2022 pods : Pod []","title":"pods"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/","text":"Interface: RadioGroupProps # Renderer . Component .RadioGroupProps Type parameters # Name T Table of contents # Properties # asButtons children className disabled onChange value Properties # asButtons # \u2022 Optional asButtons : boolean children # \u2022 children : SingleOrMany < ReactElement < RadioProps < T >, string | JSXElementConstructor < any >>> className # \u2022 Optional className : string disabled # \u2022 Optional disabled : boolean onChange # \u2022 onChange : ( value : T ) => void Type declaration # \u25b8 ( value ): void Parameters # Name Type value T Returns # void value # \u2022 Optional value : T","title":"Interface: RadioGroupProps"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#interface-radiogrouppropst","text":"Renderer . Component .RadioGroupProps","title":"Interface: RadioGroupProps<T>"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#type-parameters","text":"Name T","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#properties","text":"asButtons children className disabled onChange value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#asbuttons","text":"\u2022 Optional asButtons : boolean","title":"asButtons"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#children","text":"\u2022 children : SingleOrMany < ReactElement < RadioProps < T >, string | JSXElementConstructor < any >>>","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#onchange","text":"\u2022 onChange : ( value : T ) => void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#value","text":"\u2022 Optional value : T","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/","text":"Interface: RadioProps # Renderer . Component .RadioProps Type parameters # Name T Table of contents # Properties # className disabled label value Properties # className # \u2022 Optional className : string disabled # \u2022 Optional disabled : boolean label # \u2022 label : ReactNode value # \u2022 value : T","title":"Interface: RadioProps"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#interface-radiopropst","text":"Renderer . Component .RadioProps","title":"Interface: RadioProps<T>"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#type-parameters","text":"Name T","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#properties","text":"className disabled label value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#label","text":"\u2022 label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#value","text":"\u2022 value : T","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/","text":"Interface: SearchInputProps # Renderer . Component .SearchInputProps Hierarchy # InputProps \u21b3 SearchInputProps Table of contents # Properties # autoSelectOnFocus bindGlobalFocusHotkey blurOnEnter compact contentRight dirty iconLeft iconRight maxRows multiLine showClearIcon showErrorsAsTooltip showValidationLine theme trim validators Methods # onChange onClear onSubmit Properties # autoSelectOnFocus # \u2022 Optional autoSelectOnFocus : boolean Inherited from # InputProps.autoSelectOnFocus bindGlobalFocusHotkey # \u2022 Optional bindGlobalFocusHotkey : boolean blurOnEnter # \u2022 Optional blurOnEnter : boolean Inherited from # InputProps.blurOnEnter compact # \u2022 Optional compact : boolean contentRight # \u2022 Optional contentRight : ReactNode Inherited from # InputProps.contentRight dirty # \u2022 Optional dirty : boolean Inherited from # InputProps.dirty iconLeft # \u2022 Optional iconLeft : IconData Inherited from # InputProps.iconLeft iconRight # \u2022 Optional iconRight : IconData Inherited from # InputProps.iconRight maxRows # \u2022 Optional maxRows : number Inherited from # InputProps.maxRows multiLine # \u2022 Optional multiLine : boolean Inherited from # InputProps.multiLine showClearIcon # \u2022 Optional showClearIcon : boolean showErrorsAsTooltip # \u2022 Optional showErrorsAsTooltip : boolean | Omit < TooltipProps , \"targetId\" > Inherited from # InputProps.showErrorsAsTooltip showValidationLine # \u2022 Optional showValidationLine : boolean Inherited from # InputProps.showValidationLine theme # \u2022 Optional theme : \"round-black\" | \"round\" Inherited from # InputProps.theme trim # \u2022 Optional trim : boolean Inherited from # InputProps.trim validators # \u2022 Optional validators : SingleOrMany < InputValidator < boolean >> Inherited from # InputProps.validators Methods # onChange # \u25b8 Optional onChange ( value , evt ): void Parameters # Name Type value string evt ChangeEvent < InputElement > Returns # void Inherited from # InputProps.onChange onClear # \u25b8 Optional onClear (): void Returns # void onSubmit # \u25b8 Optional onSubmit ( value , evt ): void Parameters # Name Type value string evt KeyboardEvent < InputElement > Returns # void Inherited from # InputProps.onSubmit","title":"Interface: SearchInputProps"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#interface-searchinputprops","text":"Renderer . Component .SearchInputProps","title":"Interface: SearchInputProps"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#hierarchy","text":"InputProps \u21b3 SearchInputProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#properties","text":"autoSelectOnFocus bindGlobalFocusHotkey blurOnEnter compact contentRight dirty iconLeft iconRight maxRows multiLine showClearIcon showErrorsAsTooltip showValidationLine theme trim validators","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#methods","text":"onChange onClear onSubmit","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#autoselectonfocus","text":"\u2022 Optional autoSelectOnFocus : boolean","title":"autoSelectOnFocus"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#bindglobalfocushotkey","text":"\u2022 Optional bindGlobalFocusHotkey : boolean","title":"bindGlobalFocusHotkey"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#bluronenter","text":"\u2022 Optional blurOnEnter : boolean","title":"blurOnEnter"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#compact","text":"\u2022 Optional compact : boolean","title":"compact"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#contentright","text":"\u2022 Optional contentRight : ReactNode","title":"contentRight"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#dirty","text":"\u2022 Optional dirty : boolean","title":"dirty"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#iconleft","text":"\u2022 Optional iconLeft : IconData","title":"iconLeft"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#iconright","text":"\u2022 Optional iconRight : IconData","title":"iconRight"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#maxrows","text":"\u2022 Optional maxRows : number","title":"maxRows"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#multiline","text":"\u2022 Optional multiLine : boolean","title":"multiLine"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#showclearicon","text":"\u2022 Optional showClearIcon : boolean","title":"showClearIcon"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#showerrorsastooltip","text":"\u2022 Optional showErrorsAsTooltip : boolean | Omit < TooltipProps , \"targetId\" >","title":"showErrorsAsTooltip"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#showvalidationline","text":"\u2022 Optional showValidationLine : boolean","title":"showValidationLine"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#theme","text":"\u2022 Optional theme : \"round-black\" | \"round\"","title":"theme"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#trim","text":"\u2022 Optional trim : boolean","title":"trim"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#validators","text":"\u2022 Optional validators : SingleOrMany < InputValidator < boolean >>","title":"validators"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#onchange","text":"\u25b8 Optional onChange ( value , evt ): void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#onclear","text":"\u25b8 Optional onClear (): void","title":"onClear"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#onsubmit","text":"\u25b8 Optional onSubmit ( value , evt ): void","title":"onSubmit"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/","text":"Interface: SelectOption # Renderer . Component .SelectOption Type parameters # Name Value Table of contents # Properties # id isDisabled isSelected label value Properties # id # \u2022 Optional id : string isDisabled # \u2022 Optional isDisabled : boolean isSelected # \u2022 Optional isSelected : boolean label # \u2022 label : ReactNode value # \u2022 value : Value","title":"Interface: SelectOption"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#interface-selectoptionvalue","text":"Renderer . Component .SelectOption","title":"Interface: SelectOption<Value>"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#type-parameters","text":"Name Value","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#properties","text":"id isDisabled isSelected label value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#isdisabled","text":"\u2022 Optional isDisabled : boolean","title":"isDisabled"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#isselected","text":"\u2022 Optional isSelected : boolean","title":"isSelected"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#label","text":"\u2022 label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#value","text":"\u2022 value : Value","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/","text":"Interface: SelectProps # Renderer . Component .SelectProps Type parameters # Name Type Value Value Option extends SelectOption < Value > IsMulti extends boolean Group extends GroupBase < Option > = GroupBase < Option > Hierarchy # Omit < ReactSelectProps < Option , IsMulti , Group >, \"value\" | \"options\" > \u21b3 SelectProps Table of contents # Properties # autoConvertOptions id isCreatable menuClass options themeName value Properties # autoConvertOptions # \u2022 Optional autoConvertOptions : boolean Deprecated We will always auto convert options if they are of type string id # \u2022 Optional id : string Overrides # Omit.id isCreatable # \u2022 Optional isCreatable : boolean Deprecated This option does nothing menuClass # \u2022 Optional menuClass : string options # \u2022 options : OptionsOrGroups < Option , Group > | LegacyAutoConvertedOptions themeName # \u2022 Optional themeName : \"dark\" | \"light\" | \"outlined\" | \"lens\" value # \u2022 Optional value : PropsValue < Value >","title":"Interface: SelectProps"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#interface-selectpropsvalue-option-ismulti-group","text":"Renderer . Component .SelectProps","title":"Interface: SelectProps<Value, Option, IsMulti, Group>"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#type-parameters","text":"Name Type Value Value Option extends SelectOption < Value > IsMulti extends boolean Group extends GroupBase < Option > = GroupBase < Option >","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#hierarchy","text":"Omit < ReactSelectProps < Option , IsMulti , Group >, \"value\" | \"options\" > \u21b3 SelectProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#properties","text":"autoConvertOptions id isCreatable menuClass options themeName value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#autoconvertoptions","text":"\u2022 Optional autoConvertOptions : boolean Deprecated We will always auto convert options if they are of type string","title":"autoConvertOptions"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#iscreatable","text":"\u2022 Optional isCreatable : boolean Deprecated This option does nothing","title":"isCreatable"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#menuclass","text":"\u2022 Optional menuClass : string","title":"menuClass"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#options","text":"\u2022 options : OptionsOrGroups < Option , Group > | LegacyAutoConvertedOptions","title":"options"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#themename","text":"\u2022 Optional themeName : \"dark\" | \"light\" | \"outlined\" | \"lens\"","title":"themeName"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#value","text":"\u2022 Optional value : PropsValue < Value >","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/","text":"Interface: SettingLayoutProps # Renderer . Component .SettingLayoutProps Hierarchy # DOMAttributes < any > \u21b3 SettingLayoutProps Table of contents # Properties # back className closeButtonProps contentClass contentGaps navigation provideBackButtonNavigation Properties # back # \u2022 Optional back : ( evt : MouseEvent < Element , MouseEvent > | KeyboardEvent ) => void Type declaration # \u25b8 ( evt ): void Parameters # Name Type evt MouseEvent < Element , MouseEvent > | KeyboardEvent Returns # void className # \u2022 Optional className : IClassName closeButtonProps # \u2022 Optional closeButtonProps : Object Type declaration # Name Type data-testid? string contentClass # \u2022 Optional contentClass : IClassName contentGaps # \u2022 Optional contentGaps : boolean navigation # \u2022 Optional navigation : ReactNode provideBackButtonNavigation # \u2022 Optional provideBackButtonNavigation : boolean","title":"Interface: SettingLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#interface-settinglayoutprops","text":"Renderer . Component .SettingLayoutProps","title":"Interface: SettingLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#hierarchy","text":"DOMAttributes < any > \u21b3 SettingLayoutProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#properties","text":"back className closeButtonProps contentClass contentGaps navigation provideBackButtonNavigation","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#back","text":"\u2022 Optional back : ( evt : MouseEvent < Element , MouseEvent > | KeyboardEvent ) => void","title":"back"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#classname","text":"\u2022 Optional className : IClassName","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#closebuttonprops","text":"\u2022 Optional closeButtonProps : Object","title":"closeButtonProps"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#contentclass","text":"\u2022 Optional contentClass : IClassName","title":"contentClass"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#contentgaps","text":"\u2022 Optional contentGaps : boolean","title":"contentGaps"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#navigation","text":"\u2022 Optional navigation : ReactNode","title":"navigation"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#providebackbuttonnavigation","text":"\u2022 Optional provideBackButtonNavigation : boolean","title":"provideBackButtonNavigation"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/","text":"Interface: SliderProps # Renderer . Component .SliderProps Hierarchy # Omit < MaterialSliderProps , \"onChange\" > \u21b3 SliderProps Table of contents # Properties # className Methods # onChange Properties # className # \u2022 Optional className : string Overrides # Omit.className Methods # onChange # \u25b8 onChange ( evt , value ): void Parameters # Name Type evt FormEvent < any > value number Returns # void","title":"Interface: SliderProps"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#interface-sliderprops","text":"Renderer . Component .SliderProps","title":"Interface: SliderProps"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#hierarchy","text":"Omit < MaterialSliderProps , \"onChange\" > \u21b3 SliderProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#properties","text":"className","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#methods","text":"onChange","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#onchange","text":"\u25b8 onChange ( evt , value ): void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/","text":"Interface: SpinnerProps # Renderer . Component .SpinnerProps Hierarchy # HTMLProps < any > \u21b3 SpinnerProps Table of contents # Properties # center singleColor Properties # center # \u2022 Optional center : boolean singleColor # \u2022 Optional singleColor : boolean","title":"Interface: SpinnerProps"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#interface-spinnerprops","text":"Renderer . Component .SpinnerProps","title":"Interface: SpinnerProps"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#hierarchy","text":"HTMLProps < any > \u21b3 SpinnerProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#properties","text":"center singleColor","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#center","text":"\u2022 Optional center : boolean","title":"center"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#singlecolor","text":"\u2022 Optional singleColor : boolean","title":"singleColor"},{"location":"extensions/api/interfaces/Renderer.Component.StatusBrickProps/","text":"Interface: StatusBrickProps # Renderer . Component .StatusBrickProps Hierarchy # HTMLAttributes < HTMLDivElement > \u21b3 StatusBrickProps","title":"Interface: StatusBrickProps"},{"location":"extensions/api/interfaces/Renderer.Component.StatusBrickProps/#interface-statusbrickprops","text":"Renderer . Component .StatusBrickProps","title":"Interface: StatusBrickProps"},{"location":"extensions/api/interfaces/Renderer.Component.StatusBrickProps/#hierarchy","text":"HTMLAttributes < HTMLDivElement > \u21b3 StatusBrickProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/","text":"Interface: StepperProps # Renderer . Component .StepperProps Hierarchy # HTMLProps < any > \u21b3 StepperProps Table of contents # Properties # step steps Properties # step # \u2022 step : number Overrides # React.HTMLProps.step steps # \u2022 steps : Step []","title":"Interface: StepperProps"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#interface-stepperprops","text":"Renderer . Component .StepperProps","title":"Interface: StepperProps"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#hierarchy","text":"HTMLProps < any > \u21b3 StepperProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#properties","text":"step steps","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#step","text":"\u2022 step : number","title":"step"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#steps","text":"\u2022 steps : Step []","title":"steps"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/","text":"Interface: SubTitleProps # Renderer . Component .SubTitleProps Table of contents # Properties # children className compact id title Properties # children # \u2022 Optional children : SingleOrMany < ReactNode > className # \u2022 Optional className : string compact # \u2022 Optional compact : boolean id # \u2022 Optional id : string title # \u2022 title : ReactNode","title":"Interface: SubTitleProps"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#interface-subtitleprops","text":"Renderer . Component .SubTitleProps","title":"Interface: SubTitleProps"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#properties","text":"children className compact id title","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#children","text":"\u2022 Optional children : SingleOrMany < ReactNode >","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#compact","text":"\u2022 Optional compact : boolean","title":"compact"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#title","text":"\u2022 title : ReactNode","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/","text":"Interface: SwitchProps # Renderer . Component .SwitchProps Hierarchy # Omit < HTMLProps < HTMLInputElement >, \"onChange\" > \u21b3 SwitchProps Table of contents # Properties # onChange Properties # onChange # \u2022 Optional onChange : ( checked : boolean , event : ChangeEvent < HTMLInputElement >) => void Type declaration # \u25b8 ( checked , event ): void Parameters # Name Type checked boolean event ChangeEvent < HTMLInputElement > Returns # void","title":"Interface: SwitchProps"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#interface-switchprops","text":"Renderer . Component .SwitchProps","title":"Interface: SwitchProps"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#hierarchy","text":"Omit < HTMLProps < HTMLInputElement >, \"onChange\" > \u21b3 SwitchProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#properties","text":"onChange","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#onchange","text":"\u2022 Optional onChange : ( checked : boolean , event : ChangeEvent < HTMLInputElement >) => void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/","text":"Interface: SwitcherProps # Renderer . Component .SwitcherProps Table of contents # Properties # checked children disabled name onChange Properties # checked # \u2022 Optional checked : boolean children # \u2022 Optional children : ReactNode disabled # \u2022 Optional disabled : boolean name # \u2022 Optional name : string onChange # \u2022 Optional onChange : ( event : ChangeEvent < HTMLInputElement >, checked : boolean ) => void Type declaration # \u25b8 ( event , checked ): void Parameters # Name Type event ChangeEvent < HTMLInputElement > checked boolean Returns # void","title":"Interface: SwitcherProps"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#interface-switcherprops","text":"Renderer . Component .SwitcherProps","title":"Interface: SwitcherProps"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#properties","text":"checked children disabled name onChange","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#checked","text":"\u2022 Optional checked : boolean","title":"checked"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#name","text":"\u2022 Optional name : string","title":"name"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#onchange","text":"\u2022 Optional onChange : ( event : ChangeEvent < HTMLInputElement >, checked : boolean ) => void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/","text":"Interface: TabLayoutProps # Renderer . Component .TabLayoutProps Table of contents # Properties # children className contentClass scrollable tabs Properties # children # \u2022 Optional children : ReactNode className # \u2022 Optional className : IClassName contentClass # \u2022 Optional contentClass : IClassName scrollable # \u2022 Optional scrollable : boolean tabs # \u2022 Optional tabs : TabLayoutRoute []","title":"Interface: TabLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#interface-tablayoutprops","text":"Renderer . Component .TabLayoutProps","title":"Interface: TabLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#properties","text":"children className contentClass scrollable tabs","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#classname","text":"\u2022 Optional className : IClassName","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#contentclass","text":"\u2022 Optional contentClass : IClassName","title":"contentClass"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#scrollable","text":"\u2022 Optional scrollable : boolean","title":"scrollable"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#tabs","text":"\u2022 Optional tabs : TabLayoutRoute []","title":"tabs"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/","text":"Interface: TabLayoutRoute # Renderer . Component .TabLayoutRoute Table of contents # Properties # component default exact routePath title url Properties # component # \u2022 component : ComponentType < any > default # \u2022 Optional default : boolean exact # \u2022 Optional exact : boolean routePath # \u2022 routePath : string title # \u2022 title : ReactNode url # \u2022 Optional url : string","title":"Interface: TabLayoutRoute"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#interface-tablayoutroute","text":"Renderer . Component .TabLayoutRoute","title":"Interface: TabLayoutRoute"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#properties","text":"component default exact routePath title url","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#component","text":"\u2022 component : ComponentType < any >","title":"component"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#default","text":"\u2022 Optional default : boolean","title":"default"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#exact","text":"\u2022 Optional exact : boolean","title":"exact"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#routepath","text":"\u2022 routePath : string","title":"routePath"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#title","text":"\u2022 title : ReactNode","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#url","text":"\u2022 Optional url : string","title":"url"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/","text":"Interface: TabProps # Renderer . Component .TabProps Type parameters # Name D Hierarchy # DOMAttributes < HTMLElement > \u21b3 TabProps Table of contents # Properties # active className disabled icon id label value Properties # active # \u2022 Optional active : boolean className # \u2022 Optional className : string disabled # \u2022 Optional disabled : boolean icon # \u2022 Optional icon : ReactNode id # \u2022 Optional id : string label # \u2022 Optional label : ReactNode value # \u2022 value : D","title":"Interface: TabProps"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#interface-tabpropsd","text":"Renderer . Component .TabProps","title":"Interface: TabProps<D>"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#hierarchy","text":"DOMAttributes < HTMLElement > \u21b3 TabProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#properties","text":"active className disabled icon id label value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#icon","text":"\u2022 Optional icon : ReactNode","title":"icon"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#label","text":"\u2022 Optional label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#value","text":"\u2022 value : D","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/","text":"Interface: TableCellProps # Renderer . Component .TableCellProps Hierarchy # DOMAttributes < HTMLDivElement > \u21b3 TableCellProps Table of contents # Properties # _nowrap _sorting checkbox className id isChecked scrollable showWithColumn sortBy title Methods # _sort Properties # _nowrap # \u2022 Optional _nowrap : boolean indicator, might come from parent , don't use this prop outside (!) _sorting # \u2022 Optional _sorting : Partial < TableSortParams > checkbox # \u2022 Optional checkbox : boolean render cell with a checkbox className # \u2022 Optional className : string Any css class names for this table cell. Only used if title is a \"simple\" react node id # \u2022 Optional id : string used for configuration visibility of columns isChecked # \u2022 Optional isChecked : boolean mark checkbox as checked or not scrollable # \u2022 Optional scrollable : boolean content inside could be scrolled showWithColumn # \u2022 Optional showWithColumn : string id of the column which follow same visibility rules sortBy # \u2022 Optional sortBy : string column name, must be same as key in sortable object title # \u2022 Optional title : ReactNode The actual value of the cell Methods # _sort # \u25b8 Optional _sort ( sortBy ): void Parameters # Name Type sortBy string Returns # void","title":"Interface: TableCellProps"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#interface-tablecellprops","text":"Renderer . Component .TableCellProps","title":"Interface: TableCellProps"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#hierarchy","text":"DOMAttributes < HTMLDivElement > \u21b3 TableCellProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#properties","text":"_nowrap _sorting checkbox className id isChecked scrollable showWithColumn sortBy title","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#methods","text":"_sort","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#_nowrap","text":"\u2022 Optional _nowrap : boolean indicator, might come from parent , don't use this prop outside (!)","title":"_nowrap"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#_sorting","text":"\u2022 Optional _sorting : Partial < TableSortParams >","title":"_sorting"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#checkbox","text":"\u2022 Optional checkbox : boolean render cell with a checkbox","title":"checkbox"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#classname","text":"\u2022 Optional className : string Any css class names for this table cell. Only used if title is a \"simple\" react node","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#id","text":"\u2022 Optional id : string used for configuration visibility of columns","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#ischecked","text":"\u2022 Optional isChecked : boolean mark checkbox as checked or not","title":"isChecked"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#scrollable","text":"\u2022 Optional scrollable : boolean content inside could be scrolled","title":"scrollable"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#showwithcolumn","text":"\u2022 Optional showWithColumn : string id of the column which follow same visibility rules","title":"showWithColumn"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#sortby","text":"\u2022 Optional sortBy : string column name, must be same as key in sortable object","title":"sortBy"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#title","text":"\u2022 Optional title : ReactNode The actual value of the cell","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#_sort","text":"\u25b8 Optional _sort ( sortBy ): void","title":"_sort"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/","text":"Interface: TableHeadProps # Renderer . Component .TableHeadProps Hierarchy # DOMAttributes < HTMLDivElement > \u21b3 TableHeadProps Table of contents # Properties # className flat nowrap showTopLine sticky Properties # className # \u2022 Optional className : string flat # \u2022 Optional flat : boolean nowrap # \u2022 Optional nowrap : boolean showTopLine # \u2022 Optional showTopLine : boolean sticky # \u2022 Optional sticky : boolean","title":"Interface: TableHeadProps"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#interface-tableheadprops","text":"Renderer . Component .TableHeadProps","title":"Interface: TableHeadProps"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#hierarchy","text":"DOMAttributes < HTMLDivElement > \u21b3 TableHeadProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#properties","text":"className flat nowrap showTopLine sticky","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#flat","text":"\u2022 Optional flat : boolean","title":"flat"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#nowrap","text":"\u2022 Optional nowrap : boolean","title":"nowrap"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#showtopline","text":"\u2022 Optional showTopLine : boolean","title":"showTopLine"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#sticky","text":"\u2022 Optional sticky : boolean","title":"sticky"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/","text":"Interface: TableProps # Renderer . Component .TableProps Type parameters # Name Item Hierarchy # DOMAttributes < HTMLDivElement > \u21b3 TableProps Table of contents # Properties # autoSize className customRowHeights getTableRow items noItems onSort renderRow rowLineHeight rowPadding scrollable selectable selectedItemId sortByDefault sortSyncWithUrl sortable storageKey tableId virtual virtualHeight Properties # autoSize # \u2022 Optional autoSize : boolean className # \u2022 Optional className : string customRowHeights # \u2022 Optional customRowHeights : ( item : Item , lineHeight : number , paddings : number ) => number Type declaration # \u25b8 ( item , lineHeight , paddings ): number Parameters # Name Type item Item lineHeight number paddings number Returns # number getTableRow # \u2022 Optional getTableRow : ( uid : string ) => undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >> Type declaration # \u25b8 ( uid ): undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >> Parameters # Name Type uid string Returns # undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >> items # \u2022 Optional items : Item [] noItems # \u2022 Optional noItems : ReactNode onSort # \u2022 Optional onSort : ( params : TableSortParams ) => void Type declaration # \u25b8 ( params ): void Parameters # Name Type params TableSortParams Returns # void renderRow # \u2022 Optional renderRow : ( item : Item ) => undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >> Type declaration # \u25b8 ( item ): undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >> Parameters # Name Type item Item Returns # undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >> rowLineHeight # \u2022 Optional rowLineHeight : number Row line height in pixels rowPadding # \u2022 Optional rowPadding : number Row padding in pixels scrollable # \u2022 Optional scrollable : boolean selectable # \u2022 Optional selectable : boolean selectedItemId # \u2022 Optional selectedItemId : string sortByDefault # \u2022 Optional sortByDefault : Partial < TableSortParams > sortSyncWithUrl # \u2022 Optional sortSyncWithUrl : boolean sortable # \u2022 Optional sortable : TableSortCallbacks < Item > Define sortable callbacks for every column in Sort Item argument in the callback is an object, provided in storageKey # \u2022 Optional storageKey : string tableId # \u2022 Optional tableId : string virtual # \u2022 Optional virtual : boolean Use virtual list component to render only visible rows. By default uses a auto sizer to fill available height virtualHeight # \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 ,","title":"Interface: TableProps"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#interface-tablepropsitem","text":"Renderer . Component .TableProps","title":"Interface: TableProps<Item>"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#type-parameters","text":"Name Item","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#hierarchy","text":"DOMAttributes < HTMLDivElement > \u21b3 TableProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#properties","text":"autoSize className customRowHeights getTableRow items noItems onSort renderRow rowLineHeight rowPadding scrollable selectable selectedItemId sortByDefault sortSyncWithUrl sortable storageKey tableId virtual virtualHeight","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#autosize","text":"\u2022 Optional autoSize : boolean","title":"autoSize"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#customrowheights","text":"\u2022 Optional customRowHeights : ( item : Item , lineHeight : number , paddings : number ) => number","title":"customRowHeights"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#gettablerow","text":"\u2022 Optional getTableRow : ( uid : string ) => undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >>","title":"getTableRow"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#items","text":"\u2022 Optional items : Item []","title":"items"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#noitems","text":"\u2022 Optional noItems : ReactNode","title":"noItems"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#onsort","text":"\u2022 Optional onSort : ( params : TableSortParams ) => void","title":"onSort"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#renderrow","text":"\u2022 Optional renderRow : ( item : Item ) => undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >>","title":"renderRow"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#rowlineheight","text":"\u2022 Optional rowLineHeight : number Row line height in pixels","title":"rowLineHeight"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#rowpadding","text":"\u2022 Optional rowPadding : number Row padding in pixels","title":"rowPadding"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#scrollable","text":"\u2022 Optional scrollable : boolean","title":"scrollable"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#selectable","text":"\u2022 Optional selectable : boolean","title":"selectable"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#selecteditemid","text":"\u2022 Optional selectedItemId : string","title":"selectedItemId"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#sortbydefault","text":"\u2022 Optional sortByDefault : Partial < TableSortParams >","title":"sortByDefault"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#sortsyncwithurl","text":"\u2022 Optional sortSyncWithUrl : boolean","title":"sortSyncWithUrl"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#sortable","text":"\u2022 Optional sortable : TableSortCallbacks < Item > Define sortable callbacks for every column in Sort Item argument in the callback is an object, provided in","title":"sortable"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#storagekey","text":"\u2022 Optional storageKey : string","title":"storageKey"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#tableid","text":"\u2022 Optional tableId : string","title":"tableId"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#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","title":"virtual"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#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 ,","title":"virtualHeight"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/","text":"Interface: TableRowProps # Renderer . Component .TableRowProps Type parameters # Name Item Hierarchy # DOMAttributes < HTMLDivElement > \u21b3 TableRowProps Table of contents # Properties # className disabled nowrap searchItem selected sortItem style testId Properties # className # \u2022 Optional className : string disabled # \u2022 Optional disabled : boolean nowrap # \u2022 Optional nowrap : boolean searchItem # \u2022 Optional searchItem : Item selected # \u2022 Optional selected : boolean sortItem # \u2022 Optional sortItem : Item style # \u2022 Optional style : CSSProperties testId # \u2022 Optional testId : string","title":"Interface: TableRowProps"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#interface-tablerowpropsitem","text":"Renderer . Component .TableRowProps","title":"Interface: TableRowProps<Item>"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#type-parameters","text":"Name Item","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#hierarchy","text":"DOMAttributes < HTMLDivElement > \u21b3 TableRowProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#properties","text":"className disabled nowrap searchItem selected sortItem style testId","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#nowrap","text":"\u2022 Optional nowrap : boolean","title":"nowrap"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#searchitem","text":"\u2022 Optional searchItem : Item","title":"searchItem"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#selected","text":"\u2022 Optional selected : boolean","title":"selected"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#sortitem","text":"\u2022 Optional sortItem : Item","title":"sortItem"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#testid","text":"\u2022 Optional testId : string","title":"testId"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/","text":"Interface: TableSortParams # Renderer . Component .TableSortParams Table of contents # Properties # orderBy sortBy Properties # orderBy # \u2022 orderBy : TableOrderBy sortBy # \u2022 sortBy : string","title":"Interface: TableSortParams"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#interface-tablesortparams","text":"Renderer . Component .TableSortParams","title":"Interface: TableSortParams"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#properties","text":"orderBy sortBy","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#orderby","text":"\u2022 orderBy : TableOrderBy","title":"orderBy"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#sortby","text":"\u2022 sortBy : string","title":"sortBy"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/","text":"Interface: TabsProps # Renderer . Component .TabsProps Type parameters # Name D Hierarchy # TabsContextValue < D > Omit < DOMAttributes < HTMLElement >, \"onChange\" > \u21b3 TabsProps Table of contents # Properties # autoFocus center className scrollable value withBorder wrap Methods # onChange Properties # autoFocus # \u2022 Optional autoFocus : boolean Inherited from # TabsContextValue.autoFocus center # \u2022 Optional center : boolean className # \u2022 Optional className : string scrollable # \u2022 Optional scrollable : boolean value # \u2022 Optional value : D Inherited from # TabsContextValue.value withBorder # \u2022 Optional withBorder : boolean Inherited from # TabsContextValue.withBorder wrap # \u2022 Optional wrap : boolean Methods # onChange # \u25b8 Optional onChange ( value ): void Parameters # Name Type value D Returns # void Inherited from # TabsContextValue.onChange","title":"Interface: TabsProps"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#interface-tabspropsd","text":"Renderer . Component .TabsProps","title":"Interface: TabsProps<D>"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#hierarchy","text":"TabsContextValue < D > Omit < DOMAttributes < HTMLElement >, \"onChange\" > \u21b3 TabsProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#properties","text":"autoFocus center className scrollable value withBorder wrap","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#methods","text":"onChange","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#center","text":"\u2022 Optional center : boolean","title":"center"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#scrollable","text":"\u2022 Optional scrollable : boolean","title":"scrollable"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#value","text":"\u2022 Optional value : D","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#withborder","text":"\u2022 Optional withBorder : boolean","title":"withBorder"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#wrap","text":"\u2022 Optional wrap : boolean","title":"wrap"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#onchange","text":"\u25b8 Optional onChange ( value ): void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/","text":"Interface: TooltipContentFormatters # Renderer . Component .TooltipContentFormatters Table of contents # Properties # narrow nowrap small tableView warning Properties # narrow # \u2022 Optional narrow : boolean nowrap # \u2022 Optional nowrap : boolean small # \u2022 Optional small : boolean tableView # \u2022 Optional tableView : boolean warning # \u2022 Optional warning : boolean","title":"Interface: TooltipContentFormatters"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#interface-tooltipcontentformatters","text":"Renderer . Component .TooltipContentFormatters","title":"Interface: TooltipContentFormatters"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#properties","text":"narrow nowrap small tableView warning","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#narrow","text":"\u2022 Optional narrow : boolean","title":"narrow"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#nowrap","text":"\u2022 Optional nowrap : boolean","title":"nowrap"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#small","text":"\u2022 Optional small : boolean","title":"small"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#tableview","text":"\u2022 Optional tableView : boolean","title":"tableView"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#warning","text":"\u2022 Optional warning : boolean","title":"warning"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/","text":"Interface: TooltipDecoratorProps # Renderer . Component .TooltipDecoratorProps Table of contents # Properties # children id tooltip tooltipOverrideDisabled Properties # children # \u2022 Optional children : SingleOrMany < ReactNode > id # \u2022 Optional id : string tooltip # \u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" > tooltipOverrideDisabled # \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\"","title":"Interface: TooltipDecoratorProps"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#interface-tooltipdecoratorprops","text":"Renderer . Component .TooltipDecoratorProps","title":"Interface: TooltipDecoratorProps"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#properties","text":"children id tooltip tooltipOverrideDisabled","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#children","text":"\u2022 Optional children : SingleOrMany < ReactNode >","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#tooltip","text":"\u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" >","title":"tooltip"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#tooltipoverridedisabled","text":"\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\"","title":"tooltipOverrideDisabled"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/","text":"Interface: TooltipProps # Renderer . Component .TooltipProps Table of contents # Properties # children className formatters offset preferredPositions style targetId tooltipOnParentHover usePortal visible Properties # children # \u2022 Optional children : ReactNode className # \u2022 Optional className : IClassName formatters # \u2022 Optional formatters : TooltipContentFormatters offset # \u2022 Optional offset : number preferredPositions # \u2022 Optional preferredPositions : TooltipPosition | TooltipPosition [] style # \u2022 Optional style : CSSProperties targetId # \u2022 targetId : string tooltipOnParentHover # \u2022 Optional tooltipOnParentHover : boolean usePortal # \u2022 Optional usePortal : boolean visible # \u2022 Optional visible : boolean","title":"Interface: TooltipProps"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#interface-tooltipprops","text":"Renderer . Component .TooltipProps","title":"Interface: TooltipProps"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#properties","text":"children className formatters offset preferredPositions style targetId tooltipOnParentHover usePortal visible","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#classname","text":"\u2022 Optional className : IClassName","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#formatters","text":"\u2022 Optional formatters : TooltipContentFormatters","title":"formatters"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#offset","text":"\u2022 Optional offset : number","title":"offset"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#preferredpositions","text":"\u2022 Optional preferredPositions : TooltipPosition | TooltipPosition []","title":"preferredPositions"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#targetid","text":"\u2022 targetId : string","title":"targetId"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#tooltiponparenthover","text":"\u2022 Optional tooltipOnParentHover : boolean","title":"tooltipOnParentHover"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#useportal","text":"\u2022 Optional usePortal : boolean","title":"usePortal"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#visible","text":"\u2022 Optional visible : boolean","title":"visible"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/","text":"Interface: WizardCommonProps # Renderer . Component .WizardCommonProps Type parameters # Name D Hierarchy # WizardCommonProps \u21b3 WizardProps \u21b3 WizardStepProps Table of contents # Properties # data done hideSteps reset save Properties # data # \u2022 Optional data : Partial < D > done # \u2022 Optional done : () => void Type declaration # \u25b8 (): void Returns # void hideSteps # \u2022 Optional hideSteps : boolean reset # \u2022 Optional reset : () => void Type declaration # \u25b8 (): void Returns # void save # \u2022 Optional save : ( data : Partial < D >, callback? : () => void ) => void Type declaration # \u25b8 ( data , callback? ): void Parameters # Name Type data Partial < D > callback? () => void Returns # void","title":"Interface: WizardCommonProps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#interface-wizardcommonpropsd","text":"Renderer . Component .WizardCommonProps","title":"Interface: WizardCommonProps<D>"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#hierarchy","text":"WizardCommonProps \u21b3 WizardProps \u21b3 WizardStepProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#properties","text":"data done hideSteps reset save","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#data","text":"\u2022 Optional data : Partial < D >","title":"data"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#done","text":"\u2022 Optional done : () => void","title":"done"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#hidesteps","text":"\u2022 Optional hideSteps : boolean","title":"hideSteps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#reset","text":"\u2022 Optional reset : () => void","title":"reset"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#save","text":"\u2022 Optional save : ( data : Partial < D >, callback? : () => void ) => void","title":"save"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/","text":"Interface: WizardLayoutProps # Renderer . Component .WizardLayoutProps Hierarchy # DOMAttributes < any > \u21b3 WizardLayoutProps Table of contents # Properties # centered className contentClass header headerClass infoPanel infoPanelClass Properties # centered # \u2022 Optional centered : boolean className # \u2022 Optional className : IClassName contentClass # \u2022 Optional contentClass : IClassName header # \u2022 Optional header : ReactNode headerClass # \u2022 Optional headerClass : IClassName infoPanel # \u2022 Optional infoPanel : ReactNode infoPanelClass # \u2022 Optional infoPanelClass : IClassName","title":"Interface: WizardLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#interface-wizardlayoutprops","text":"Renderer . Component .WizardLayoutProps","title":"Interface: WizardLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#hierarchy","text":"DOMAttributes < any > \u21b3 WizardLayoutProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#properties","text":"centered className contentClass header headerClass infoPanel infoPanelClass","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#centered","text":"\u2022 Optional centered : boolean","title":"centered"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#classname","text":"\u2022 Optional className : IClassName","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#contentclass","text":"\u2022 Optional contentClass : IClassName","title":"contentClass"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#header","text":"\u2022 Optional header : ReactNode","title":"header"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#headerclass","text":"\u2022 Optional headerClass : IClassName","title":"headerClass"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#infopanel","text":"\u2022 Optional infoPanel : ReactNode","title":"infoPanel"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#infopanelclass","text":"\u2022 Optional infoPanelClass : IClassName","title":"infoPanelClass"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/","text":"Interface: WizardProps # Renderer . Component .WizardProps Type parameters # Name D Hierarchy # WizardCommonProps < D > \u21b3 WizardProps Table of contents # Properties # children className data done header hideSteps onChange reset save step title Properties # children # \u2022 Optional children : ReactElement < WizardStepProps < D >, string | JSXElementConstructor < any >> | ReactElement < WizardStepProps < D >, string | JSXElementConstructor < any >>[] className # \u2022 Optional className : string data # \u2022 Optional data : Partial < D > Inherited from # WizardCommonProps . data done # \u2022 Optional done : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # WizardCommonProps . done header # \u2022 Optional header : ReactNode hideSteps # \u2022 Optional hideSteps : boolean Inherited from # WizardCommonProps . hideSteps onChange # \u2022 Optional onChange : ( step : number ) => void Type declaration # \u25b8 ( step ): void Parameters # Name Type step number Returns # void reset # \u2022 Optional reset : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # WizardCommonProps . reset save # \u2022 Optional save : ( data : Partial < D >, callback? : () => void ) => void Type declaration # \u25b8 ( data , callback? ): void Parameters # Name Type data Partial < D > callback? () => void Returns # void Inherited from # WizardCommonProps . save step # \u2022 Optional step : number title # \u2022 Optional title : string","title":"Interface: WizardProps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#interface-wizardpropsd","text":"Renderer . Component .WizardProps","title":"Interface: WizardProps<D>"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#hierarchy","text":"WizardCommonProps < D > \u21b3 WizardProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#properties","text":"children className data done header hideSteps onChange reset save step title","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#children","text":"\u2022 Optional children : ReactElement < WizardStepProps < D >, string | JSXElementConstructor < any >> | ReactElement < WizardStepProps < D >, string | JSXElementConstructor < any >>[]","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#data","text":"\u2022 Optional data : Partial < D >","title":"data"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#done","text":"\u2022 Optional done : () => void","title":"done"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#header","text":"\u2022 Optional header : ReactNode","title":"header"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#hidesteps","text":"\u2022 Optional hideSteps : boolean","title":"hideSteps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#onchange","text":"\u2022 Optional onChange : ( step : number ) => void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#reset","text":"\u2022 Optional reset : () => void","title":"reset"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#save","text":"\u2022 Optional save : ( data : Partial < D >, callback? : () => void ) => void","title":"save"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#step","text":"\u2022 Optional step : number","title":"step"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/","text":"Interface: WizardStepProps # Renderer . Component .WizardStepProps Type parameters # Name D Hierarchy # WizardCommonProps < D > \u21b3 WizardStepProps Table of contents # Properties # afterContent beforeContent children className contentClass customButtons data disabledNext done first hideBackBtn hideNextBtn hideSteps isFirst isLast last loading moreButtons next nextLabel noValidate prev prevLabel reset save scrollable skip step testIdForNext testIdForPrev title waiting wizard Properties # afterContent # \u2022 Optional afterContent : ReactNode beforeContent # \u2022 Optional beforeContent : ReactNode children # \u2022 Optional children : ReactNode | ReactNode [] className # \u2022 Optional className : string | object contentClass # \u2022 Optional contentClass : string | object customButtons # \u2022 Optional customButtons : ReactNode data # \u2022 Optional data : Partial < D > Inherited from # WizardCommonProps . data disabledNext # \u2022 Optional disabledNext : boolean done # \u2022 Optional done : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # WizardCommonProps . done first # \u2022 Optional first : () => void Type declaration # \u25b8 (): void Returns # void hideBackBtn # \u2022 Optional hideBackBtn : boolean hideNextBtn # \u2022 Optional hideNextBtn : boolean hideSteps # \u2022 Optional hideSteps : boolean Inherited from # WizardCommonProps . hideSteps isFirst # \u2022 Optional isFirst : () => boolean Type declaration # \u25b8 (): boolean Returns # boolean isLast # \u2022 Optional isLast : () => boolean Type declaration # \u25b8 (): boolean Returns # boolean last # \u2022 Optional last : () => void Type declaration # \u25b8 (): void Returns # void loading # \u2022 Optional loading : boolean moreButtons # \u2022 Optional moreButtons : ReactNode next # \u2022 Optional next : () => boolean | void | Promise < any > Type declaration # \u25b8 (): boolean | void | Promise < any > Returns # boolean | void | Promise < any > nextLabel # \u2022 Optional nextLabel : ReactNode noValidate # \u2022 Optional noValidate : boolean prev # \u2022 Optional prev : () => void Type declaration # \u25b8 (): void Returns # void prevLabel # \u2022 Optional prevLabel : ReactNode reset # \u2022 Optional reset : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # WizardCommonProps . reset save # \u2022 Optional save : ( data : Partial < D >, callback? : () => void ) => void Type declaration # \u25b8 ( data , callback? ): void Parameters # Name Type data Partial < D > callback? () => void Returns # void Inherited from # WizardCommonProps . save scrollable # \u2022 Optional scrollable : boolean skip # \u2022 Optional skip : boolean step # \u2022 Optional step : number testIdForNext # \u2022 Optional testIdForNext : string testIdForPrev # \u2022 Optional testIdForPrev : string title # \u2022 Optional title : string waiting # \u2022 Optional waiting : boolean wizard # \u2022 Optional wizard : Wizard < D >","title":"Interface: WizardStepProps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#interface-wizardsteppropsd","text":"Renderer . Component .WizardStepProps","title":"Interface: WizardStepProps<D>"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hierarchy","text":"WizardCommonProps < D > \u21b3 WizardStepProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#properties","text":"afterContent beforeContent children className contentClass customButtons data disabledNext done first hideBackBtn hideNextBtn hideSteps isFirst isLast last loading moreButtons next nextLabel noValidate prev prevLabel reset save scrollable skip step testIdForNext testIdForPrev title waiting wizard","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#aftercontent","text":"\u2022 Optional afterContent : ReactNode","title":"afterContent"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#beforecontent","text":"\u2022 Optional beforeContent : ReactNode","title":"beforeContent"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#children","text":"\u2022 Optional children : ReactNode | ReactNode []","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#classname","text":"\u2022 Optional className : string | object","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#contentclass","text":"\u2022 Optional contentClass : string | object","title":"contentClass"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#custombuttons","text":"\u2022 Optional customButtons : ReactNode","title":"customButtons"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#data","text":"\u2022 Optional data : Partial < D >","title":"data"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#disablednext","text":"\u2022 Optional disabledNext : boolean","title":"disabledNext"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#done","text":"\u2022 Optional done : () => void","title":"done"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#first","text":"\u2022 Optional first : () => void","title":"first"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hidebackbtn","text":"\u2022 Optional hideBackBtn : boolean","title":"hideBackBtn"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hidenextbtn","text":"\u2022 Optional hideNextBtn : boolean","title":"hideNextBtn"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hidesteps","text":"\u2022 Optional hideSteps : boolean","title":"hideSteps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#isfirst","text":"\u2022 Optional isFirst : () => boolean","title":"isFirst"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#islast","text":"\u2022 Optional isLast : () => boolean","title":"isLast"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#last","text":"\u2022 Optional last : () => void","title":"last"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#loading","text":"\u2022 Optional loading : boolean","title":"loading"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#morebuttons","text":"\u2022 Optional moreButtons : ReactNode","title":"moreButtons"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#next","text":"\u2022 Optional next : () => boolean | void | Promise < any >","title":"next"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#nextlabel","text":"\u2022 Optional nextLabel : ReactNode","title":"nextLabel"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#novalidate","text":"\u2022 Optional noValidate : boolean","title":"noValidate"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#prev","text":"\u2022 Optional prev : () => void","title":"prev"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#prevlabel","text":"\u2022 Optional prevLabel : ReactNode","title":"prevLabel"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#reset","text":"\u2022 Optional reset : () => void","title":"reset"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#save","text":"\u2022 Optional save : ( data : Partial < D >, callback? : () => void ) => void","title":"save"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#scrollable","text":"\u2022 Optional scrollable : boolean","title":"scrollable"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#skip","text":"\u2022 Optional skip : boolean","title":"skip"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#step","text":"\u2022 Optional step : number","title":"step"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#testidfornext","text":"\u2022 Optional testIdForNext : string","title":"testIdForNext"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#testidforprev","text":"\u2022 Optional testIdForPrev : string","title":"testIdForPrev"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#waiting","text":"\u2022 Optional waiting : boolean","title":"waiting"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#wizard","text":"\u2022 Optional wizard : Wizard < D >","title":"wizard"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IKubeApiCluster/","text":"Interface: IKubeApiCluster # Renderer . K8sApi .IKubeApiCluster Deprecated This type is unused Table of contents # Properties # metadata Properties # metadata # \u2022 metadata : Object Type declaration # Name Type uid string","title":"Interface: IKubeApiCluster"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IKubeApiCluster/#interface-ikubeapicluster","text":"Renderer . K8sApi .IKubeApiCluster Deprecated This type is unused","title":"Interface: IKubeApiCluster"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IKubeApiCluster/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IKubeApiCluster/#properties","text":"metadata","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IKubeApiCluster/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IKubeApiCluster/#metadata","text":"\u2022 metadata : Object","title":"metadata"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/","text":"Interface: IgnoredKubeApiOptions # Renderer . K8sApi .IgnoredKubeApiOptions Deprecated This type is only present for backwards compatable typescript support Table of contents # Properties # apiBase isNamespaces kind objectConstructor Properties # apiBase # \u2022 Optional apiBase : any Deprecated this option is overridden and should not be used isNamespaces # \u2022 Optional isNamespaces : any Deprecated this option is overridden and should not be used kind # \u2022 Optional kind : any Deprecated this option is overridden and should not be used objectConstructor # \u2022 Optional objectConstructor : any Deprecated this option is overridden and should not be used","title":"Interface: IgnoredKubeApiOptions"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#interface-ignoredkubeapioptions","text":"Renderer . K8sApi .IgnoredKubeApiOptions Deprecated This type is only present for backwards compatable typescript support","title":"Interface: IgnoredKubeApiOptions"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#properties","text":"apiBase isNamespaces kind objectConstructor","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#apibase","text":"\u2022 Optional apiBase : any Deprecated this option is overridden and should not be used","title":"apiBase"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#isnamespaces","text":"\u2022 Optional isNamespaces : any Deprecated this option is overridden and should not be used","title":"isNamespaces"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#kind","text":"\u2022 Optional kind : any Deprecated this option is overridden and should not be used","title":"kind"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#objectconstructor","text":"\u2022 Optional objectConstructor : any Deprecated this option is overridden and should not be used","title":"objectConstructor"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/","text":"Interface: KubeObjectStatus # Renderer . K8sApi .KubeObjectStatus Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Table of contents # Properties # level text timestamp Properties # level # \u2022 level : KubeObjectStatusLevel text # \u2022 text : string timestamp # \u2022 Optional timestamp : string","title":"Interface: KubeObjectStatus"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#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.","title":"Interface: KubeObjectStatus"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#properties","text":"level text timestamp","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#level","text":"\u2022 level : KubeObjectStatusLevel","title":"level"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#text","text":"\u2022 text : string","title":"text"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#timestamp","text":"\u2022 Optional timestamp : string","title":"timestamp"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/","text":"Interface: PageParamInit # Renderer . Navigation .PageParamInit Type parameters # Name Type Value any Table of contents # Properties # defaultValue name Methods # parse stringify Properties # defaultValue # \u2022 Optional defaultValue : Value name # \u2022 name : string Methods # parse # \u25b8 Optional parse ( value ): Value Parameters # Name Type value string | string [] Returns # Value stringify # \u25b8 Optional stringify ( value ): string | string [] Parameters # Name Type value Value Returns # string | string []","title":"Interface: PageParamInit"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#interface-pageparaminitvalue","text":"Renderer . Navigation .PageParamInit","title":"Interface: PageParamInit<Value>"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#type-parameters","text":"Name Type Value any","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#properties","text":"defaultValue name","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#methods","text":"parse stringify","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#defaultvalue","text":"\u2022 Optional defaultValue : Value","title":"defaultValue"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#parse","text":"\u25b8 Optional parse ( value ): Value","title":"parse"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#stringify","text":"\u25b8 Optional stringify ( value ): string | string []","title":"stringify"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/","text":"Interface: URLParams # Renderer . Navigation .URLParams Type parameters # Name Type P extends object = {} Q extends object = {} Table of contents # Properties # fragment params query Properties # fragment # \u2022 Optional fragment : string params # \u2022 Optional params : P query # \u2022 Optional query : Q","title":"Interface: URLParams"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#interface-urlparamsp-q","text":"Renderer . Navigation .URLParams","title":"Interface: URLParams<P, Q>"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#type-parameters","text":"Name Type P extends object = {} Q extends object = {}","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#properties","text":"fragment params query","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#fragment","text":"\u2022 Optional fragment : string","title":"fragment"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#params","text":"\u2022 Optional params : P","title":"params"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#query","text":"\u2022 Optional query : Q","title":"query"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/","text":"Interface: LensTheme # Renderer . Theme .LensTheme Table of contents # Properties # author colors description isDefault monacoTheme name terminalColors type Properties # author # \u2022 author : string colors # \u2022 colors : Record < LensColorName , string > description # \u2022 description : string isDefault # \u2022 Optional isDefault : boolean monacoTheme # \u2022 monacoTheme : MonacoTheme name # \u2022 name : string terminalColors # \u2022 terminalColors : Partial < Record < TerminalColorName , string >> type # \u2022 type : LensThemeType","title":"Interface: LensTheme"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#interface-lenstheme","text":"Renderer . Theme .LensTheme","title":"Interface: LensTheme"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#properties","text":"author colors description isDefault monacoTheme name terminalColors type","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#author","text":"\u2022 author : string","title":"author"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#colors","text":"\u2022 colors : Record < LensColorName , string >","title":"colors"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#description","text":"\u2022 description : string","title":"description"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#isdefault","text":"\u2022 Optional isDefault : boolean","title":"isDefault"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#monacotheme","text":"\u2022 monacoTheme : MonacoTheme","title":"monacoTheme"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#terminalcolors","text":"\u2022 terminalColors : Partial < Record < TerminalColorName , string >>","title":"terminalColors"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#type","text":"\u2022 type : LensThemeType","title":"type"},{"location":"extensions/api/modules/Common.Catalog/","text":"Namespace: Catalog # Common .Catalog Table of contents # Classes # CatalogCategory CatalogEntity GeneralEntity KubernetesCluster KubernetesClusterCategory WebLink Interfaces # CatalogCategoryEvents CatalogCategoryMetadata CatalogCategorySpec CatalogCategoryVersion CatalogEntityActionContext CatalogEntityAddMenu CatalogEntityAddMenuContext CatalogEntityContextMenu CatalogEntityContextMenuContext CatalogEntityContextMenuNavigate CatalogEntityData CatalogEntityKindData CatalogEntityMetadata CatalogEntitySettingsContext CatalogEntitySettingsMenu CatalogEntityStatus CategoryColumnRegistration GeneralEntitySpec KubernetesClusterMetadata KubernetesClusterPrometheusMetrics KubernetesClusterSpec KubernetesClusterStatus TitleCellProps WebLinkSpec WebLinkStatus Type Aliases # AddMenuFilter CatalogEntityConstructor CatalogEntityDataFor CatalogEntityInstanceFrom CatalogEntitySpec EntityMetadataObject EntityMetadataValue KubernetesClusterStatusPhase WebLinkStatusPhase Variables # kubernetesClusterCategory Functions # categoryVersion Type Aliases # AddMenuFilter # \u01ac AddMenuFilter : ( menu : CatalogEntityAddMenu ) => any Type declaration # \u25b8 ( menu ): any If the filter return a thruthy value, the menu item is displayed Parameters # Name Type menu CatalogEntityAddMenu Returns # any CatalogEntityConstructor # \u01ac CatalogEntityConstructor < Entity >: ( data : CatalogEntityDataFor < Entity >) => Entity Type parameters # Name Type Entity extends CatalogEntity Type declaration # \u2022 ( data ) Parameters # Name Type data CatalogEntityDataFor < Entity > CatalogEntityDataFor # \u01ac CatalogEntityDataFor < Entity >: Entity extends CatalogEntity ? CatalogEntityData < Metadata , Status , Spec > : never Type parameters # Name Entity CatalogEntityInstanceFrom # \u01ac CatalogEntityInstanceFrom < Constructor >: Constructor extends CatalogEntityConstructor ? Entity : never Type parameters # Name Constructor CatalogEntitySpec # \u01ac CatalogEntitySpec : Record < string , any > EntityMetadataObject # \u01ac EntityMetadataObject : { [Key in string]?: EntityMetadataValue } EntityMetadataValue # \u01ac EntityMetadataValue : string | number | boolean | EntityMetadataObject | undefined KubernetesClusterStatusPhase # \u01ac KubernetesClusterStatusPhase : \"connected\" | \"connecting\" | \"disconnected\" | \"deleting\" Deprecated This is no longer used as it is incorrect. Other sources can add more values WebLinkStatusPhase # \u01ac WebLinkStatusPhase : \"available\" | \"unavailable\" Variables # kubernetesClusterCategory # \u2022 Const kubernetesClusterCategory : KubernetesClusterCategory Functions # categoryVersion # \u25b8 categoryVersion < T , Metadata , Status , Spec >( name , entityClass ): CatalogCategoryVersion Type parameters # Name Type T extends CatalogEntity < Metadata , Status , Spec , T > Metadata extends CatalogEntityMetadata < Metadata > Status extends CatalogEntityStatus Spec extends CatalogEntitySpec Parameters # Name Type name string entityClass ( data : CatalogEntityData < Metadata , Status , Spec >) => T Returns # CatalogCategoryVersion","title":"Namespace: Catalog"},{"location":"extensions/api/modules/Common.Catalog/#namespace-catalog","text":"Common .Catalog","title":"Namespace: Catalog"},{"location":"extensions/api/modules/Common.Catalog/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Common.Catalog/#classes","text":"CatalogCategory CatalogEntity GeneralEntity KubernetesCluster KubernetesClusterCategory WebLink","title":"Classes"},{"location":"extensions/api/modules/Common.Catalog/#interfaces","text":"CatalogCategoryEvents CatalogCategoryMetadata CatalogCategorySpec CatalogCategoryVersion CatalogEntityActionContext CatalogEntityAddMenu CatalogEntityAddMenuContext CatalogEntityContextMenu CatalogEntityContextMenuContext CatalogEntityContextMenuNavigate CatalogEntityData CatalogEntityKindData CatalogEntityMetadata CatalogEntitySettingsContext CatalogEntitySettingsMenu CatalogEntityStatus CategoryColumnRegistration GeneralEntitySpec KubernetesClusterMetadata KubernetesClusterPrometheusMetrics KubernetesClusterSpec KubernetesClusterStatus TitleCellProps WebLinkSpec WebLinkStatus","title":"Interfaces"},{"location":"extensions/api/modules/Common.Catalog/#type-aliases","text":"AddMenuFilter CatalogEntityConstructor CatalogEntityDataFor CatalogEntityInstanceFrom CatalogEntitySpec EntityMetadataObject EntityMetadataValue KubernetesClusterStatusPhase WebLinkStatusPhase","title":"Type Aliases"},{"location":"extensions/api/modules/Common.Catalog/#variables","text":"kubernetesClusterCategory","title":"Variables"},{"location":"extensions/api/modules/Common.Catalog/#functions","text":"categoryVersion","title":"Functions"},{"location":"extensions/api/modules/Common.Catalog/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Common.Catalog/#addmenufilter","text":"\u01ac AddMenuFilter : ( menu : CatalogEntityAddMenu ) => any","title":"AddMenuFilter"},{"location":"extensions/api/modules/Common.Catalog/#catalogentityconstructor","text":"\u01ac CatalogEntityConstructor < Entity >: ( data : CatalogEntityDataFor < Entity >) => Entity","title":"CatalogEntityConstructor"},{"location":"extensions/api/modules/Common.Catalog/#catalogentitydatafor","text":"\u01ac CatalogEntityDataFor < Entity >: Entity extends CatalogEntity ? CatalogEntityData < Metadata , Status , Spec > : never","title":"CatalogEntityDataFor"},{"location":"extensions/api/modules/Common.Catalog/#catalogentityinstancefrom","text":"\u01ac CatalogEntityInstanceFrom < Constructor >: Constructor extends CatalogEntityConstructor ? Entity : never","title":"CatalogEntityInstanceFrom"},{"location":"extensions/api/modules/Common.Catalog/#catalogentityspec","text":"\u01ac CatalogEntitySpec : Record < string , any >","title":"CatalogEntitySpec"},{"location":"extensions/api/modules/Common.Catalog/#entitymetadataobject","text":"\u01ac EntityMetadataObject : { [Key in string]?: EntityMetadataValue }","title":"EntityMetadataObject"},{"location":"extensions/api/modules/Common.Catalog/#entitymetadatavalue","text":"\u01ac EntityMetadataValue : string | number | boolean | EntityMetadataObject | undefined","title":"EntityMetadataValue"},{"location":"extensions/api/modules/Common.Catalog/#kubernetesclusterstatusphase","text":"\u01ac KubernetesClusterStatusPhase : \"connected\" | \"connecting\" | \"disconnected\" | \"deleting\" Deprecated This is no longer used as it is incorrect. Other sources can add more values","title":"KubernetesClusterStatusPhase"},{"location":"extensions/api/modules/Common.Catalog/#weblinkstatusphase","text":"\u01ac WebLinkStatusPhase : \"available\" | \"unavailable\"","title":"WebLinkStatusPhase"},{"location":"extensions/api/modules/Common.Catalog/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Common.Catalog/#kubernetesclustercategory","text":"\u2022 Const kubernetesClusterCategory : KubernetesClusterCategory","title":"kubernetesClusterCategory"},{"location":"extensions/api/modules/Common.Catalog/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Common.Catalog/#categoryversion","text":"\u25b8 categoryVersion < T , Metadata , Status , Spec >( name , entityClass ): CatalogCategoryVersion","title":"categoryVersion"},{"location":"extensions/api/modules/Common.EventBus/","text":"Namespace: EventBus # Common .EventBus Table of contents # Classes # EventEmitter Interfaces # AppEvent EventEmitterOptions Type Aliases # EventEmitterCallback Variables # appEventBus Type Aliases # EventEmitterCallback # \u01ac EventEmitterCallback < D >: (... data : D ) => void | boolean Type parameters # Name Type D extends any [] Type declaration # \u25b8 ( ...data ): void | boolean Parameters # Name Type ...data D Returns # void | boolean Variables # appEventBus # \u2022 Const appEventBus : EventEmitter <[ AppEvent ]>","title":"Namespace: EventBus"},{"location":"extensions/api/modules/Common.EventBus/#namespace-eventbus","text":"Common .EventBus","title":"Namespace: EventBus"},{"location":"extensions/api/modules/Common.EventBus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Common.EventBus/#classes","text":"EventEmitter","title":"Classes"},{"location":"extensions/api/modules/Common.EventBus/#interfaces","text":"AppEvent EventEmitterOptions","title":"Interfaces"},{"location":"extensions/api/modules/Common.EventBus/#type-aliases","text":"EventEmitterCallback","title":"Type Aliases"},{"location":"extensions/api/modules/Common.EventBus/#variables","text":"appEventBus","title":"Variables"},{"location":"extensions/api/modules/Common.EventBus/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Common.EventBus/#eventemittercallback","text":"\u01ac EventEmitterCallback < D >: (... data : D ) => void | boolean","title":"EventEmitterCallback"},{"location":"extensions/api/modules/Common.EventBus/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Common.EventBus/#appeventbus","text":"\u2022 Const appEventBus : EventEmitter <[ AppEvent ]>","title":"appEventBus"},{"location":"extensions/api/modules/Common.Proxy/","text":"Namespace: Proxy # Common .Proxy Table of contents # Functions # resolveSystemProxy Functions # resolveSystemProxy # \u25b8 resolveSystemProxy ( url ): Promise < string > Resolves URL-specific proxy information from system. See more here: https://www.electronjs.org/docs/latest/api/session#sesresolveproxyurl Parameters # Name Type Description url string The URL for proxy information Returns # Promise < string > Promise for proxy information as string","title":"Namespace: Proxy"},{"location":"extensions/api/modules/Common.Proxy/#namespace-proxy","text":"Common .Proxy","title":"Namespace: Proxy"},{"location":"extensions/api/modules/Common.Proxy/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Common.Proxy/#functions","text":"resolveSystemProxy","title":"Functions"},{"location":"extensions/api/modules/Common.Proxy/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Common.Proxy/#resolvesystemproxy","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","title":"resolveSystemProxy"},{"location":"extensions/api/modules/Common.Store/","text":"Namespace: Store # Common .Store Table of contents # Classes # ExtensionStore Interfaces # BaseStoreParams","title":"Namespace: Store"},{"location":"extensions/api/modules/Common.Store/#namespace-store","text":"Common .Store","title":"Namespace: Store"},{"location":"extensions/api/modules/Common.Store/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Common.Store/#classes","text":"ExtensionStore","title":"Classes"},{"location":"extensions/api/modules/Common.Store/#interfaces","text":"BaseStoreParams","title":"Interfaces"},{"location":"extensions/api/modules/Common.Types/","text":"Namespace: Types # Common .Types Table of contents # Interfaces # AppPreferenceComponents AppPreferenceRegistration ClusterPageMenuComponents ClusterPageMenuRegistration CustomCategoryViewComponents CustomCategoryViewProps CustomCategoryViewRegistration KubeObjectContextMenuItem KubeObjectDetailComponents KubeObjectDetailRegistration KubeObjectHandlers KubeObjectMenuComponents KubeObjectMenuRegistration KubeObjectOnContextMenuOpenContext KubeObjectStatusRegistration PageComponentProps PageComponents PageParams PageRegistration PageTarget ProtocolHandlerRegistration ProtocolRouteHandler ProtocolRouteParams RegisteredPage ShellEnvContext StatusBarRegistration TrayMenuRegistration Type Aliases # IpcMainEvent IpcMainInvokeEvent IpcRendererEvent KubeObjectHandlerRegistration KubeObjectOnContextMenuOpen MenuRegistration ShellEnvModifier Type Aliases # IpcMainEvent # \u01ac IpcMainEvent : Electron.IpcMainEvent IpcMainInvokeEvent # \u01ac IpcMainInvokeEvent : Electron.IpcMainInvokeEvent Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. IpcRendererEvent # \u01ac IpcRendererEvent : Electron.IpcRendererEvent KubeObjectHandlerRegistration # \u01ac KubeObjectHandlerRegistration : { apiVersions : string [] ; kind : string } & RequireAtLeastOne < KubeObjectHandlers > KubeObjectOnContextMenuOpen # \u01ac KubeObjectOnContextMenuOpen : ( ctx : KubeObjectOnContextMenuOpenContext ) => void Type declaration # \u25b8 ( ctx ): void Parameters # Name Type ctx KubeObjectOnContextMenuOpenContext Returns # void MenuRegistration # \u01ac MenuRegistration : { parentId : string ; visible? : IComputedValue < boolean > | boolean } & Omit < MenuItemConstructorOptions , \"visible\" > ShellEnvModifier # \u01ac ShellEnvModifier : ( ctx : ShellEnvContext , env : Record < string , string | undefined >) => Record < string , string | undefined > Type declaration # \u25b8 ( ctx , env ): Record < string , string | undefined > Parameters # Name Type ctx ShellEnvContext env Record < string , string | undefined > Returns # Record < string , string | undefined >","title":"Namespace: Types"},{"location":"extensions/api/modules/Common.Types/#namespace-types","text":"Common .Types","title":"Namespace: Types"},{"location":"extensions/api/modules/Common.Types/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Common.Types/#interfaces","text":"AppPreferenceComponents AppPreferenceRegistration ClusterPageMenuComponents ClusterPageMenuRegistration CustomCategoryViewComponents CustomCategoryViewProps CustomCategoryViewRegistration KubeObjectContextMenuItem KubeObjectDetailComponents KubeObjectDetailRegistration KubeObjectHandlers KubeObjectMenuComponents KubeObjectMenuRegistration KubeObjectOnContextMenuOpenContext KubeObjectStatusRegistration PageComponentProps PageComponents PageParams PageRegistration PageTarget ProtocolHandlerRegistration ProtocolRouteHandler ProtocolRouteParams RegisteredPage ShellEnvContext StatusBarRegistration TrayMenuRegistration","title":"Interfaces"},{"location":"extensions/api/modules/Common.Types/#type-aliases","text":"IpcMainEvent IpcMainInvokeEvent IpcRendererEvent KubeObjectHandlerRegistration KubeObjectOnContextMenuOpen MenuRegistration ShellEnvModifier","title":"Type Aliases"},{"location":"extensions/api/modules/Common.Types/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Common.Types/#ipcmainevent","text":"\u01ac IpcMainEvent : Electron.IpcMainEvent","title":"IpcMainEvent"},{"location":"extensions/api/modules/Common.Types/#ipcmaininvokeevent","text":"\u01ac IpcMainInvokeEvent : Electron.IpcMainInvokeEvent Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"IpcMainInvokeEvent"},{"location":"extensions/api/modules/Common.Types/#ipcrendererevent","text":"\u01ac IpcRendererEvent : Electron.IpcRendererEvent","title":"IpcRendererEvent"},{"location":"extensions/api/modules/Common.Types/#kubeobjecthandlerregistration","text":"\u01ac KubeObjectHandlerRegistration : { apiVersions : string [] ; kind : string } & RequireAtLeastOne < KubeObjectHandlers >","title":"KubeObjectHandlerRegistration"},{"location":"extensions/api/modules/Common.Types/#kubeobjectoncontextmenuopen","text":"\u01ac KubeObjectOnContextMenuOpen : ( ctx : KubeObjectOnContextMenuOpenContext ) => void","title":"KubeObjectOnContextMenuOpen"},{"location":"extensions/api/modules/Common.Types/#menuregistration","text":"\u01ac MenuRegistration : { parentId : string ; visible? : IComputedValue < boolean > | boolean } & Omit < MenuItemConstructorOptions , \"visible\" >","title":"MenuRegistration"},{"location":"extensions/api/modules/Common.Types/#shellenvmodifier","text":"\u01ac ShellEnvModifier : ( ctx : ShellEnvContext , env : Record < string , string | undefined >) => Record < string , string | undefined >","title":"ShellEnvModifier"},{"location":"extensions/api/modules/Common.Util/","text":"Namespace: Util # Common .Util Table of contents # Classes # Singleton Interfaces # Disposable Disposer ExtendableDisposer Type Aliases # IClassName IgnoredClassNames OpenLinkInBrowser Functions # cssNames disposer getAppVersion openBrowser openExternal prevDefault stopPropagation Type Aliases # IClassName # \u01ac IClassName : string | string [] | Record < string , any > | undefined | null | false | IgnoredClassNames 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. OpenLinkInBrowser # \u01ac OpenLinkInBrowser : ( url : string ) => Promise < void > Type declaration # \u25b8 ( url ): Promise < void > Parameters # Name Type url string Returns # Promise < void > Functions # cssNames # \u25b8 cssNames ( ...classNames ): string Parameters # Name Type ...classNames IClassName [] Returns # string disposer # \u25b8 disposer ( ...items ): ExtendableDisposer Parameters # Name Type ...items SingleOrMany < undefined | null | Disposer | Disposable >[] Returns # ExtendableDisposer getAppVersion # \u25b8 getAppVersion (): string Returns # string openBrowser # \u25b8 openBrowser ( url ): Promise < void > Parameters # Name Type url string Returns # Promise < void > openExternal # \u25b8 openExternal ( url ): Promise < void > Parameters # Name Type url string Returns # Promise < void > prevDefault # \u25b8 prevDefault < E , R >( callback ): ( event : E ) => R Type parameters # Name Type E extends Event | SyntheticEvent < Element , Event > R R Parameters # Name Type callback ( evt : E ) => R Returns # fn \u25b8 ( event ): R Parameters # Name Type event E Returns # R stopPropagation # \u25b8 stopPropagation ( evt ): void Parameters # Name Type evt Event | SyntheticEvent < Element , Event > Returns # void","title":"Namespace: Util"},{"location":"extensions/api/modules/Common.Util/#namespace-util","text":"Common .Util","title":"Namespace: Util"},{"location":"extensions/api/modules/Common.Util/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Common.Util/#classes","text":"Singleton","title":"Classes"},{"location":"extensions/api/modules/Common.Util/#interfaces","text":"Disposable Disposer ExtendableDisposer","title":"Interfaces"},{"location":"extensions/api/modules/Common.Util/#type-aliases","text":"IClassName IgnoredClassNames OpenLinkInBrowser","title":"Type Aliases"},{"location":"extensions/api/modules/Common.Util/#functions","text":"cssNames disposer getAppVersion openBrowser openExternal prevDefault stopPropagation","title":"Functions"},{"location":"extensions/api/modules/Common.Util/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Common.Util/#iclassname","text":"\u01ac IClassName : string | string [] | Record < string , any > | undefined | null | false | IgnoredClassNames","title":"IClassName"},{"location":"extensions/api/modules/Common.Util/#ignoredclassnames","text":"\u01ac IgnoredClassNames : number | symbol | Function Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"IgnoredClassNames"},{"location":"extensions/api/modules/Common.Util/#openlinkinbrowser","text":"\u01ac OpenLinkInBrowser : ( url : string ) => Promise < void >","title":"OpenLinkInBrowser"},{"location":"extensions/api/modules/Common.Util/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Common.Util/#cssnames","text":"\u25b8 cssNames ( ...classNames ): string","title":"cssNames"},{"location":"extensions/api/modules/Common.Util/#disposer","text":"\u25b8 disposer ( ...items ): ExtendableDisposer","title":"disposer"},{"location":"extensions/api/modules/Common.Util/#getappversion","text":"\u25b8 getAppVersion (): string","title":"getAppVersion"},{"location":"extensions/api/modules/Common.Util/#openbrowser","text":"\u25b8 openBrowser ( url ): Promise < void >","title":"openBrowser"},{"location":"extensions/api/modules/Common.Util/#openexternal","text":"\u25b8 openExternal ( url ): Promise < void >","title":"openExternal"},{"location":"extensions/api/modules/Common.Util/#prevdefault","text":"\u25b8 prevDefault < E , R >( callback ): ( event : E ) => R","title":"prevDefault"},{"location":"extensions/api/modules/Common.Util/#stoppropagation","text":"\u25b8 stopPropagation ( evt ): void","title":"stopPropagation"},{"location":"extensions/api/modules/Common/","text":"Namespace: Common # Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Table of contents # Namespaces # Catalog EventBus Proxy Store Types Util Classes # LensExtension Interfaces # InstalledExtension LensExtensionManifest Logger Variables # App logger Variables # App # \u2022 Const App : Object Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Type declaration # Name Type Preferences { getKubectlPath : () => string | undefined } Preferences.getKubectlPath () => string | undefined appName string getEnabledExtensions () => string [] isLinux boolean isMac boolean isSnap boolean isWindows boolean issuesTrackerUrl string slackUrl string version string logger # \u2022 Const logger : Logger","title":"Namespace: Common"},{"location":"extensions/api/modules/Common/#namespace-common","text":"Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"Namespace: Common"},{"location":"extensions/api/modules/Common/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Common/#namespaces","text":"Catalog EventBus Proxy Store Types Util","title":"Namespaces"},{"location":"extensions/api/modules/Common/#classes","text":"LensExtension","title":"Classes"},{"location":"extensions/api/modules/Common/#interfaces","text":"InstalledExtension LensExtensionManifest Logger","title":"Interfaces"},{"location":"extensions/api/modules/Common/#variables","text":"App logger","title":"Variables"},{"location":"extensions/api/modules/Common/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Common/#app","text":"\u2022 Const App : Object Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"App"},{"location":"extensions/api/modules/Common/#logger","text":"\u2022 Const logger : Logger","title":"logger"},{"location":"extensions/api/modules/Main.Catalog/","text":"Namespace: Catalog # Main .Catalog Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Table of contents # Interfaces # CatalogEntityRegistry Variables # catalogCategories catalogEntities Variables # catalogCategories # \u2022 Const catalogCategories : CatalogCategoryRegistry catalogEntities # \u2022 Const catalogEntities : CatalogEntityRegistry","title":"Namespace: Catalog"},{"location":"extensions/api/modules/Main.Catalog/#namespace-catalog","text":"Main .Catalog Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"Namespace: Catalog"},{"location":"extensions/api/modules/Main.Catalog/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Main.Catalog/#interfaces","text":"CatalogEntityRegistry","title":"Interfaces"},{"location":"extensions/api/modules/Main.Catalog/#variables","text":"catalogCategories catalogEntities","title":"Variables"},{"location":"extensions/api/modules/Main.Catalog/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Main.Catalog/#catalogcategories","text":"\u2022 Const catalogCategories : CatalogCategoryRegistry","title":"catalogCategories"},{"location":"extensions/api/modules/Main.Catalog/#catalogentities","text":"\u2022 Const catalogEntities : CatalogEntityRegistry","title":"catalogEntities"},{"location":"extensions/api/modules/Main.K8sApi/","text":"Namespace: K8sApi # Main .K8sApi Table of contents # Classes # ClusterRole ClusterRoleBinding ConfigMap CronJob CustomResourceDefinition DaemonSet Deployment Endpoint HorizontalPodAutoscaler Ingress Job KubeEvent KubeObject KubeObjectStore KubeStatus LimitRange Namespace NetworkPolicy Node PersistentVolume PersistentVolumeClaim Pod PodDisruptionBudget PriorityClass ReplicaSet ResourceQuota ResourceStack Role RoleBinding Secret Service ServiceAccount StatefulSet StorageClass Interfaces # BaseKubeJsonApiObjectMetadata IKubeApiCluster ILocalKubeApiConfig IPodContainer IPodContainerStatus IRemoteKubeApiConfig ISecretRef IgnoredKubeApiOptions KubeJsonApiData KubeObjectStoreLoadAllParams KubeObjectStoreLoadingParams KubeObjectStoreSubscribeParams KubeStatusData OwnerReference Type Aliases # ClusterScopedMetadata DeploymentApi IngressApi JsonPatch KubeApi KubeJsonApi KubeJsonApiDataFor KubeJsonApiObjectMetadata KubeObjectMetadata NamespaceScopedMetadata NodesApi PersistentVolumeClaimsApi PodsApi Variables # DeploymentApi IngressApi KubeApi KubeJsonApi NodesApi PersistentVolumeClaimsApi PodsApi apiManager Functions # createResourceStack forCluster forRemoteCluster isAllowedResource Type Aliases # ClusterScopedMetadata # \u01ac ClusterScopedMetadata : KubeObjectMetadata < KubeObjectScope.Cluster > DeploymentApi # \u01ac DeploymentApi : InternalDeploymentApi IngressApi # \u01ac IngressApi : InternalIngressApi JsonPatch # \u01ac JsonPatch : Patch KubeApi # \u01ac KubeApi < Object , Data >: InternalKubeApi < Object , Data > Type parameters # Name Type Object extends KubeObject = KubeObject Data extends KubeJsonApiDataFor < Object > = KubeJsonApiDataFor < Object > KubeJsonApi # \u01ac KubeJsonApi : InternalKubeJsonApi KubeJsonApiDataFor # \u01ac KubeJsonApiDataFor < K >: K extends KubeObject ? KubeJsonApiData < Metadata , Status , Spec > : never Type parameters # Name K KubeJsonApiObjectMetadata # \u01ac KubeJsonApiObjectMetadata < Namespaced >: BaseKubeJsonApiObjectMetadata < Namespaced > & Namespaced extends KubeObjectScope.Namespace ? { namespace : string } : {} Type parameters # Name Type Namespaced extends KubeObjectScope = KubeObjectScope KubeObjectMetadata # \u01ac KubeObjectMetadata < Namespaced >: KubeJsonApiObjectMetadata < Namespaced > & { name : string ; resourceVersion : string ; selfLink : string ; uid : string } Type parameters # Name Type Namespaced extends KubeObjectScope = KubeObjectScope NamespaceScopedMetadata # \u01ac NamespaceScopedMetadata : KubeObjectMetadata < KubeObjectScope.Namespace > NodesApi # \u01ac NodesApi : NodeApi PersistentVolumeClaimsApi # \u01ac PersistentVolumeClaimsApi : PersistentVolumeClaimApi PodsApi # \u01ac PodsApi : PodApi Variables # DeploymentApi # \u2022 DeploymentApi : ( opts? : DerivedKubeApiOptions ) => DeploymentApi Type declaration # \u2022 new DeploymentApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions IngressApi # \u2022 IngressApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => IngressApi Type declaration # \u2022 new IngressApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions KubeApi # \u2022 KubeApi : ( opts : KubeApiOptions < Object_1 , Data >) => KubeApi < Object_1 , Data > Type declaration # \u2022 new KubeApi < Object_1 , Data >( opts ) Type parameters # Name Type 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 > Parameters # Name Type opts KubeApiOptions < Object_1 , Data > KubeJsonApi # \u2022 KubeJsonApi : ( config : JsonApiConfig , reqInit? : RequestInit ) => KubeJsonApi & { forCluster : CreateKubeJsonApiForCluster } NodesApi # \u2022 NodesApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => NodeApi Type declaration # \u2022 new NodesApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions PersistentVolumeClaimsApi # \u2022 PersistentVolumeClaimsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PersistentVolumeClaimApi Type declaration # \u2022 new PersistentVolumeClaimsApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions PodsApi # \u2022 PodsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PodApi Type declaration # \u2022 new PodsApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions apiManager # \u2022 Const apiManager : ApiManager Functions # createResourceStack # \u25b8 createResourceStack ( cluster , name ): ResourceApplyingStack Parameters # Name Type cluster KubernetesCluster < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > name string Returns # ResourceApplyingStack forCluster # \u25b8 forCluster < Object , Api , Data >( cluster , kubeClass , apiClass ): Api Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Api extends KubeApi < Object , KubeJsonApiDataFor < Object >, Api > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type cluster ILocalKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass KubeApiConstructor < Object , Api > Returns # Api \u25b8 forCluster < Object , Data >( cluster , kubeClass , apiClass? ): KubeApi < Object , KubeJsonApiDataFor < Object >> Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type cluster ILocalKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass? KubeApiConstructor < Object , KubeApi < Object , KubeJsonApiDataFor < Object >>> Returns # KubeApi < Object , KubeJsonApiDataFor < Object >> forRemoteCluster # \u25b8 forRemoteCluster < Object , Api , Data >( config , kubeClass , apiClass ): Api Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Api extends KubeApi < Object , KubeJsonApiDataFor < Object >, Api > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type config IRemoteKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass KubeApiConstructor < Object , Api > Returns # Api \u25b8 forRemoteCluster < Object , Data >( config , kubeClass , apiClass? ): KubeApi < Object , KubeJsonApiDataFor < Object >> Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type config IRemoteKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass? KubeApiConstructor < Object , KubeApi < Object , KubeJsonApiDataFor < Object >>> Returns # KubeApi < Object , KubeJsonApiDataFor < Object >> isAllowedResource # \u25b8 isAllowedResource ( ...args ): boolean Deprecated This function never works Parameters # Name Type ...args any [] Returns # boolean false","title":"Namespace: K8sApi"},{"location":"extensions/api/modules/Main.K8sApi/#namespace-k8sapi","text":"Main .K8sApi","title":"Namespace: K8sApi"},{"location":"extensions/api/modules/Main.K8sApi/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Main.K8sApi/#classes","text":"ClusterRole ClusterRoleBinding ConfigMap CronJob CustomResourceDefinition DaemonSet Deployment Endpoint HorizontalPodAutoscaler Ingress Job KubeEvent KubeObject KubeObjectStore KubeStatus LimitRange Namespace NetworkPolicy Node PersistentVolume PersistentVolumeClaim Pod PodDisruptionBudget PriorityClass ReplicaSet ResourceQuota ResourceStack Role RoleBinding Secret Service ServiceAccount StatefulSet StorageClass","title":"Classes"},{"location":"extensions/api/modules/Main.K8sApi/#interfaces","text":"BaseKubeJsonApiObjectMetadata IKubeApiCluster ILocalKubeApiConfig IPodContainer IPodContainerStatus IRemoteKubeApiConfig ISecretRef IgnoredKubeApiOptions KubeJsonApiData KubeObjectStoreLoadAllParams KubeObjectStoreLoadingParams KubeObjectStoreSubscribeParams KubeStatusData OwnerReference","title":"Interfaces"},{"location":"extensions/api/modules/Main.K8sApi/#type-aliases","text":"ClusterScopedMetadata DeploymentApi IngressApi JsonPatch KubeApi KubeJsonApi KubeJsonApiDataFor KubeJsonApiObjectMetadata KubeObjectMetadata NamespaceScopedMetadata NodesApi PersistentVolumeClaimsApi PodsApi","title":"Type Aliases"},{"location":"extensions/api/modules/Main.K8sApi/#variables","text":"DeploymentApi IngressApi KubeApi KubeJsonApi NodesApi PersistentVolumeClaimsApi PodsApi apiManager","title":"Variables"},{"location":"extensions/api/modules/Main.K8sApi/#functions","text":"createResourceStack forCluster forRemoteCluster isAllowedResource","title":"Functions"},{"location":"extensions/api/modules/Main.K8sApi/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Main.K8sApi/#clusterscopedmetadata","text":"\u01ac ClusterScopedMetadata : KubeObjectMetadata < KubeObjectScope.Cluster >","title":"ClusterScopedMetadata"},{"location":"extensions/api/modules/Main.K8sApi/#deploymentapi","text":"\u01ac DeploymentApi : InternalDeploymentApi","title":"DeploymentApi"},{"location":"extensions/api/modules/Main.K8sApi/#ingressapi","text":"\u01ac IngressApi : InternalIngressApi","title":"IngressApi"},{"location":"extensions/api/modules/Main.K8sApi/#jsonpatch","text":"\u01ac JsonPatch : Patch","title":"JsonPatch"},{"location":"extensions/api/modules/Main.K8sApi/#kubeapi","text":"\u01ac KubeApi < Object , Data >: InternalKubeApi < Object , Data >","title":"KubeApi"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapi","text":"\u01ac KubeJsonApi : InternalKubeJsonApi","title":"KubeJsonApi"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapidatafor","text":"\u01ac KubeJsonApiDataFor < K >: K extends KubeObject ? KubeJsonApiData < Metadata , Status , Spec > : never","title":"KubeJsonApiDataFor"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapiobjectmetadata","text":"\u01ac KubeJsonApiObjectMetadata < Namespaced >: BaseKubeJsonApiObjectMetadata < Namespaced > & Namespaced extends KubeObjectScope.Namespace ? { namespace : string } : {}","title":"KubeJsonApiObjectMetadata"},{"location":"extensions/api/modules/Main.K8sApi/#kubeobjectmetadata","text":"\u01ac KubeObjectMetadata < Namespaced >: KubeJsonApiObjectMetadata < Namespaced > & { name : string ; resourceVersion : string ; selfLink : string ; uid : string }","title":"KubeObjectMetadata"},{"location":"extensions/api/modules/Main.K8sApi/#namespacescopedmetadata","text":"\u01ac NamespaceScopedMetadata : KubeObjectMetadata < KubeObjectScope.Namespace >","title":"NamespaceScopedMetadata"},{"location":"extensions/api/modules/Main.K8sApi/#nodesapi","text":"\u01ac NodesApi : NodeApi","title":"NodesApi"},{"location":"extensions/api/modules/Main.K8sApi/#persistentvolumeclaimsapi","text":"\u01ac PersistentVolumeClaimsApi : PersistentVolumeClaimApi","title":"PersistentVolumeClaimsApi"},{"location":"extensions/api/modules/Main.K8sApi/#podsapi","text":"\u01ac PodsApi : PodApi","title":"PodsApi"},{"location":"extensions/api/modules/Main.K8sApi/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Main.K8sApi/#deploymentapi_1","text":"\u2022 DeploymentApi : ( opts? : DerivedKubeApiOptions ) => DeploymentApi","title":"DeploymentApi"},{"location":"extensions/api/modules/Main.K8sApi/#ingressapi_1","text":"\u2022 IngressApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => IngressApi","title":"IngressApi"},{"location":"extensions/api/modules/Main.K8sApi/#kubeapi_1","text":"\u2022 KubeApi : ( opts : KubeApiOptions < Object_1 , Data >) => KubeApi < Object_1 , Data >","title":"KubeApi"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapi_1","text":"\u2022 KubeJsonApi : ( config : JsonApiConfig , reqInit? : RequestInit ) => KubeJsonApi & { forCluster : CreateKubeJsonApiForCluster }","title":"KubeJsonApi"},{"location":"extensions/api/modules/Main.K8sApi/#nodesapi_1","text":"\u2022 NodesApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => NodeApi","title":"NodesApi"},{"location":"extensions/api/modules/Main.K8sApi/#persistentvolumeclaimsapi_1","text":"\u2022 PersistentVolumeClaimsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PersistentVolumeClaimApi","title":"PersistentVolumeClaimsApi"},{"location":"extensions/api/modules/Main.K8sApi/#podsapi_1","text":"\u2022 PodsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PodApi","title":"PodsApi"},{"location":"extensions/api/modules/Main.K8sApi/#apimanager","text":"\u2022 Const apiManager : ApiManager","title":"apiManager"},{"location":"extensions/api/modules/Main.K8sApi/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Main.K8sApi/#createresourcestack","text":"\u25b8 createResourceStack ( cluster , name ): ResourceApplyingStack","title":"createResourceStack"},{"location":"extensions/api/modules/Main.K8sApi/#forcluster","text":"\u25b8 forCluster < Object , Api , Data >( cluster , kubeClass , apiClass ): Api","title":"forCluster"},{"location":"extensions/api/modules/Main.K8sApi/#forremotecluster","text":"\u25b8 forRemoteCluster < Object , Api , Data >( config , kubeClass , apiClass ): Api","title":"forRemoteCluster"},{"location":"extensions/api/modules/Main.K8sApi/#isallowedresource","text":"\u25b8 isAllowedResource ( ...args ): boolean Deprecated This function never works","title":"isAllowedResource"},{"location":"extensions/api/modules/Main.Navigation/","text":"Namespace: Navigation # Main .Navigation Table of contents # Functions # navigate Functions # navigate # \u25b8 navigate ( url ): Promise < void > Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Parameters # Name Type url string Returns # Promise < void >","title":"Namespace: Navigation"},{"location":"extensions/api/modules/Main.Navigation/#namespace-navigation","text":"Main .Navigation","title":"Namespace: Navigation"},{"location":"extensions/api/modules/Main.Navigation/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Main.Navigation/#functions","text":"navigate","title":"Functions"},{"location":"extensions/api/modules/Main.Navigation/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Main.Navigation/#navigate","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.","title":"navigate"},{"location":"extensions/api/modules/Main.Power/","text":"Namespace: Power # Main .Power Table of contents # Type Aliases # PowerEventListener Functions # onResume onShutdown onSuspend Type Aliases # PowerEventListener # \u01ac PowerEventListener : () => void Type declaration # \u25b8 (): void Event listener for system power events Returns # void Functions # onResume # \u25b8 onResume ( listener ): Disposer Adds event listener to system resume event Parameters # Name Type Description listener PowerEventListener function which will be called on system resume Returns # Disposer function to remove event listener onShutdown # \u25b8 onShutdown ( listener ): Disposer Adds event listener to the event which is emitted when the system is about to reboot or shut down Parameters # Name Type Description listener PowerEventListener function which will be called on system shutdown Returns # Disposer function to remove event listener onSuspend # \u25b8 onSuspend ( listener ): Disposer Adds event listener to system suspend events Parameters # Name Type Description listener PowerEventListener function which will be called on system suspend Returns # Disposer function to remove event listener","title":"Namespace: Power"},{"location":"extensions/api/modules/Main.Power/#namespace-power","text":"Main .Power","title":"Namespace: Power"},{"location":"extensions/api/modules/Main.Power/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Main.Power/#type-aliases","text":"PowerEventListener","title":"Type Aliases"},{"location":"extensions/api/modules/Main.Power/#functions","text":"onResume onShutdown onSuspend","title":"Functions"},{"location":"extensions/api/modules/Main.Power/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Main.Power/#powereventlistener","text":"\u01ac PowerEventListener : () => void","title":"PowerEventListener"},{"location":"extensions/api/modules/Main.Power/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Main.Power/#onresume","text":"\u25b8 onResume ( listener ): Disposer Adds event listener to system resume event","title":"onResume"},{"location":"extensions/api/modules/Main.Power/#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","title":"onShutdown"},{"location":"extensions/api/modules/Main.Power/#onsuspend","text":"\u25b8 onSuspend ( listener ): Disposer Adds event listener to system suspend events","title":"onSuspend"},{"location":"extensions/api/modules/Main/","text":"Namespace: Main # Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Table of contents # Namespaces # Catalog K8sApi Navigation Power Classes # Ipc LensExtension","title":"Namespace: Main"},{"location":"extensions/api/modules/Main/#namespace-main","text":"Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"Namespace: Main"},{"location":"extensions/api/modules/Main/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Main/#namespaces","text":"Catalog K8sApi Navigation Power","title":"Namespaces"},{"location":"extensions/api/modules/Main/#classes","text":"Ipc LensExtension","title":"Classes"},{"location":"extensions/api/modules/Renderer.Catalog/","text":"Namespace: Catalog # Renderer .Catalog Table of contents # Classes # CatalogEntityRegistry Variables # activeCluster catalogCategories catalogEntities Variables # activeCluster # \u2022 Const activeCluster : IComputedValue catalogCategories # \u2022 Const catalogCategories : CatalogCategoryRegistry catalogEntities # \u2022 Const catalogEntities : CatalogEntityRegistry","title":"Namespace: Catalog"},{"location":"extensions/api/modules/Renderer.Catalog/#namespace-catalog","text":"Renderer .Catalog","title":"Namespace: Catalog"},{"location":"extensions/api/modules/Renderer.Catalog/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Renderer.Catalog/#classes","text":"CatalogEntityRegistry","title":"Classes"},{"location":"extensions/api/modules/Renderer.Catalog/#variables","text":"activeCluster catalogCategories catalogEntities","title":"Variables"},{"location":"extensions/api/modules/Renderer.Catalog/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Renderer.Catalog/#activecluster","text":"\u2022 Const activeCluster : IComputedValue","title":"activeCluster"},{"location":"extensions/api/modules/Renderer.Catalog/#catalogcategories","text":"\u2022 Const catalogCategories : CatalogCategoryRegistry","title":"catalogCategories"},{"location":"extensions/api/modules/Renderer.Catalog/#catalogentities","text":"\u2022 Const catalogEntities : CatalogEntityRegistry","title":"catalogEntities"},{"location":"extensions/api/modules/Renderer.Component/","text":"Namespace: Component # Renderer .Component Table of contents # References # CategoryColumnRegistration Enumerations # NotificationStatus TooltipPosition Classes # DrawerParamToggler Input MenuItem NotificationsStore PageLayout SettingLayout Slider Spinner Stepper SubTitle Tab TableCell TableHead TableRow Tabs TerminalStore Tooltip Wizard WizardLayout WizardStep Interfaces # AdditionalCategoryColumnRegistration BadgeProps BarChartProps BaseIconProps ButtonProps CheckboxProps ConfirmDialogBooleanParams ConfirmDialogParams ConfirmDialogProps CreateNotificationOptions CustomPlaceholderProps DialogProps DrawerItemLabelsProps DrawerItemProps DrawerParamTogglerProps DrawerProps DrawerTitleProps IconDataFnArg IconProps KubeEventDetailsProps KubeObjectDetailsProps KubeObjectListLayoutProps KubeObjectMenuProps KubeObjectMetaProps LineProgressProps MainLayoutProps MenuActionsProps MenuContextValue MenuItemProps MenuPosition MenuProps MenuStyle MonacoEditorProps NamespaceSelectProps Notification PieChartData PieChartProps PodDetailsListProps RadioGroupProps RadioProps SearchInputProps SelectOption SelectProps SettingLayoutProps SliderProps SpinnerProps StatusBrickProps StepperProps SubTitleProps SwitchProps SwitcherProps TabLayoutProps TabLayoutRoute TabProps TableCellProps TableHeadProps TableProps TableRowProps TableSortParams TabsProps TooltipContentFormatters TooltipDecoratorProps TooltipProps WizardCommonProps WizardLayoutProps WizardProps WizardStepProps Type Aliases # DatasetTooltipLabel DrawerPosition IconData InputProps InputValidation InputValidationResult InputValidator LegacyAutoConvertedOptions MonacoCustomTheme MonacoEditorId MonacoTheme NamespaceSelectSort NotificationId NotificationMessage ShowNotification SyncValidationMessage TableCellElem TableHeadElem TableOrderBy TableRowElem TableSortBy TableSortCallback TableSortCallbacks Variables # CommandOverlay InputValidators MenuContext Notifications cpuOptions logTabStore memoryOptions notificationsStore resizingAnchorProps terminalStore Functions # Badge BarChart Button Checkbox ConfirmDialog Dialog Drawer DrawerItem DrawerItemLabels DrawerTitle FormSwitch Icon KubeEventDetails KubeObjectDetails KubeObjectListLayout KubeObjectMenu KubeObjectMeta LineProgress MainLayout Menu MenuActions MonacoEditor NamespaceSelect NamespaceSelectFilter PieChart PodDetailsList Radio RadioGroup SearchInput Select StatusBrick SubMenu Switch Switcher TabLayout Table asyncInputValidator createTerminalTab getDetailsUrl inputValidator isAsyncValidator isSvg onMultiSelectFor showDetails unionInputValidatorsAsync withTooltip References # CategoryColumnRegistration # Re-exports CategoryColumnRegistration Type Aliases # DatasetTooltipLabel # \u01ac DatasetTooltipLabel : ( percent : string ) => string | string Type declaration # \u25b8 ( percent ): string | string Parameters # Name Type percent string Returns # string | string DrawerPosition # \u01ac DrawerPosition : \"top\" | \"left\" | \"right\" | \"bottom\" IconData # \u01ac IconData : string | React.ReactNode | ( opt : IconDataFnArg ) => React.ReactNode One of the folloing: - A material icon name - A react node - Or a function that produces a react node InputProps # \u01ac InputProps : Omit < InputElementProps , \"onChange\" | \"onSubmit\" > & { autoSelectOnFocus? : boolean ; blurOnEnter? : boolean ; className? : string ; contentRight? : string | React.ReactNode ; 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 } InputValidation # \u01ac InputValidation < IsAsync >: ( value : string , props? : InputProps ) => InputValidationResult < IsAsync > Type parameters # Name Type IsAsync extends boolean Type declaration # \u25b8 ( value , props? ): InputValidationResult < IsAsync > Parameters # Name Type value string props? InputProps Returns # InputValidationResult < IsAsync > InputValidationResult # \u01ac InputValidationResult < IsAsync >: IsAsync extends true ? Promise < void > : boolean Type parameters # Name Type IsAsync extends boolean InputValidator # \u01ac InputValidator < IsAsync >: SyncInputValidator | AsyncInputValidator | IsAsync extends boolean ? LegacyInputValidator : never Type parameters # Name Type IsAsync extends boolean = boolean LegacyAutoConvertedOptions # \u01ac LegacyAutoConvertedOptions : string [] Deprecated This should not be used anymore, convert the options yourself. MonacoCustomTheme # \u01ac MonacoCustomTheme : \"clouds-midnight\" MonacoEditorId # \u01ac MonacoEditorId : string MonacoTheme # \u01ac MonacoTheme : \"vs\" | \"vs-dark\" | \"hc-black\" | MonacoCustomTheme NamespaceSelectSort # \u01ac NamespaceSelectSort : ( left : string , right : string ) => number Type declaration # \u25b8 ( left , right ): number Parameters # Name Type left string right string Returns # number NotificationId # \u01ac NotificationId : string | number NotificationMessage # \u01ac NotificationMessage : string | React.ReactElement | React.ReactElement [] | JsonApiErrorParsed | Error ShowNotification # \u01ac ShowNotification : ( message : NotificationMessage , opts? : CreateNotificationOptions ) => Disposer Type declaration # \u25b8 ( message , opts? ): Disposer Parameters # Name Type message NotificationMessage opts? CreateNotificationOptions Returns # Disposer SyncValidationMessage # \u01ac SyncValidationMessage : React.ReactNode | ( value : string , props? : InputProps ) => React.ReactNode TableCellElem # \u01ac TableCellElem : React.ReactElement < TableCellProps > TableHeadElem # \u01ac TableHeadElem : React.ReactElement < TableHeadProps > TableOrderBy # \u01ac TableOrderBy : \"asc\" | \"desc\" TableRowElem # \u01ac TableRowElem < Item >: React.ReactElement < TableRowProps < Item >> Type parameters # Name Item TableSortBy # \u01ac TableSortBy : string TableSortCallback # \u01ac TableSortCallback < Item >: ( data : Item ) => undefined | string | number | ( string | number )[] Type parameters # Name Item Type declaration # \u25b8 ( data ): undefined | string | number | ( string | number )[] Parameters # Name Type data Item Returns # undefined | string | number | ( string | number )[] TableSortCallbacks # \u01ac TableSortCallbacks < Item >: Record < string , TableSortCallback < Item >> Type parameters # Name Item Variables # CommandOverlay # \u2022 Const CommandOverlay : CommandOverlay InputValidators # \u2022 Const InputValidators : Object Type declaration # Name Type 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 MenuContext # \u2022 Const MenuContext : React.Context < MenuContextValue | null > Notifications # \u2022 Const Notifications : Object Type declaration # Name Type checkedError ShowCheckedErrorNotification error ShowNotification info ShowNotification ok ShowNotification shortInfo ShowNotification cpuOptions # \u2022 Const cpuOptions : ChartOptions logTabStore # \u2022 Const logTabStore : LogTabStore & { createPodTab : ( { selectedPod, selectedContainer } : PodLogsTabData ) => string ; createWorkloadTab : ( { workload } : WorkloadLogsTabData ) => string | undefined ; renameTab : ( tabId : string ) => void ; tabs : undefined } memoryOptions # \u2022 Const memoryOptions : ChartOptions notificationsStore # \u2022 Const notificationsStore : NotificationsStore resizingAnchorProps # \u2022 Const resizingAnchorProps : Record < DrawerPosition , [ ResizeDirection , ResizeSide , ResizeGrowthDirection ]> terminalStore # \u2022 Const terminalStore : TerminalStore & { sendCommand : SendCommand } Functions # Badge # \u25b8 Badge ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < BadgeProps & TooltipDecoratorProps > context? any Returns # null | ReactElement < any , any > BarChart # \u25b8 BarChart ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < BarChartProps > context? any Returns # null | ReactElement < any , any > Button # \u25b8 Button ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < ButtonProps & TooltipDecoratorProps > context? any Returns # null | ReactElement < any , any > Checkbox # \u25b8 Checkbox ( \u00abdestructured\u00bb ): JSX.Element Parameters # Name Type \u00abdestructured\u00bb CheckboxProps Returns # JSX.Element ConfirmDialog # \u25b8 ConfirmDialog ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < ConfirmDialogProps > context? any Returns # null | ReactElement < any , any > Dialog # \u25b8 Dialog ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < DialogProps > context? any Returns # null | ReactElement < any , any > Drawer # \u25b8 Drawer ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < DrawerProps > context? any Returns # null | ReactElement < any , any > DrawerItem # \u25b8 DrawerItem ( \u00abdestructured\u00bb ): JSX.Element | null Parameters # Name Type \u00abdestructured\u00bb DrawerItemProps Returns # JSX.Element | null DrawerItemLabels # \u25b8 DrawerItemLabels ( props ): JSX.Element | null Parameters # Name Type props DrawerItemLabelsProps Returns # JSX.Element | null DrawerTitle # \u25b8 DrawerTitle ( \u00abdestructured\u00bb ): JSX.Element Parameters # Name Type \u00abdestructured\u00bb DrawerTitleProps Returns # JSX.Element FormSwitch # \u25b8 FormSwitch ( props ): React.FunctionComponentElement < any > Deprecated Use instead from \"../switch.tsx\". Parameters # Name Type props FormControlLabelProps & { children? : ReactNode } Returns # React.FunctionComponentElement < any > Icon # \u25b8 Icon ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < IconProps & TooltipDecoratorProps > context? any Returns # null | ReactElement < any , any > KubeEventDetails # \u25b8 KubeEventDetails ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < KubeEventDetailsProps > context? any Returns # null | ReactElement < any , any > KubeObjectDetails # \u25b8 KubeObjectDetails ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props Object context? any Returns # null | ReactElement < any , any > KubeObjectListLayout # \u25b8 KubeObjectListLayout < K , A , D >( props ): ReactElement < any , string | JSXElementConstructor < any >> Type parameters # Name Type K extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , K > A extends KubeApi < K , D , A > D extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , D > = KubeJsonApiDataFor < K > Parameters # Name Type props KubeObjectListLayoutProps < K , A , D > Returns # ReactElement < any , string | JSXElementConstructor < any >> KubeObjectMenu # \u25b8 KubeObjectMenu < T >( props ): ReactElement < any , string | JSXElementConstructor < any >> Type parameters # Name Type T extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , T > Parameters # Name Type props KubeObjectMenuProps < T > Returns # ReactElement < any , string | JSXElementConstructor < any >> KubeObjectMeta # \u25b8 KubeObjectMeta ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < KubeObjectMetaProps > context? any Returns # null | ReactElement < any , any > LineProgress # \u25b8 LineProgress ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < LineProgressProps & TooltipDecoratorProps > context? any Returns # null | ReactElement < any , any > MainLayout # \u25b8 MainLayout ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < MainLayoutProps > context? any Returns # null | ReactElement < any , any > Menu # \u25b8 Menu ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < MenuProps > context? any Returns # null | ReactElement < any , any > MenuActions # \u25b8 MenuActions ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < MenuActionsProps > context? any Returns # null | ReactElement < any , any > MonacoEditor # \u25b8 MonacoEditor ( props ): null | ReactElement < any , string | JSXElementConstructor < any >> NOTE : Exotic components are not callable. Parameters # Name Type props MonacoEditorProps & RefAttributes < MonacoEditorRef > Returns # null | ReactElement < any , string | JSXElementConstructor < any >> NamespaceSelect # \u25b8 NamespaceSelect < IsMulti >( props ): JSX.Element Type parameters # Name Type IsMulti extends boolean = false Parameters # Name Type props NamespaceSelectProps < IsMulti > Returns # JSX.Element NamespaceSelectFilter # \u25b8 NamespaceSelectFilter ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < NamespaceSelectFilterProps > context? any Returns # null | ReactElement < any , any > PieChart # \u25b8 PieChart ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < PieChartProps > context? any Returns # null | ReactElement < any , any > PodDetailsList # \u25b8 PodDetailsList ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < PodDetailsListProps > context? any Returns # null | ReactElement < any , any > Radio # \u25b8 Radio < T >( \u00abdestructured\u00bb ): JSX.Element Type parameters # Name T Parameters # Name Type \u00abdestructured\u00bb RadioProps < T > Returns # JSX.Element RadioGroup # \u25b8 RadioGroup < T >( \u00abdestructured\u00bb ): JSX.Element Type parameters # Name T Parameters # Name Type \u00abdestructured\u00bb RadioGroupProps < T > Returns # JSX.Element SearchInput # \u25b8 SearchInput ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < SearchInputProps > context? any Returns # null | ReactElement < any , any > Select # \u25b8 Select < Value , Option , IsMulti , Group >( props ): ReactElement < any , string | JSXElementConstructor < any >> Type parameters # Name Type Value Value Option extends SelectOption < Value , Option > IsMulti extends boolean = false Group extends GroupBase < Option , Group > = GroupBase < Option > Parameters # Name Type props SelectProps < Value , Option , IsMulti , Group > Returns # ReactElement < any , string | JSXElementConstructor < any >> StatusBrick # \u25b8 StatusBrick ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < StatusBrickProps & TooltipDecoratorProps > context? any Returns # null | ReactElement < any , any > SubMenu # \u25b8 SubMenu ( props ): JSX.Element Parameters # Name Type props Partial < MenuProps > Returns # JSX.Element Switch # \u25b8 Switch ( \u00abdestructured\u00bb ): JSX.Element Parameters # Name Type \u00abdestructured\u00bb SwitchProps Returns # JSX.Element Switcher # \u25b8 Switcher ( \u00abdestructured\u00bb ): JSX.Element Deprecated Use instead from \"../switch.tsx\". Parameters # Name Type \u00abdestructured\u00bb SwitcherProps Returns # JSX.Element TabLayout # \u25b8 TabLayout ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < TabLayoutProps > context? any Returns # null | ReactElement < any , any > Table # \u25b8 Table < Item >( props ): ReactElement < any , string | JSXElementConstructor < any >> Type parameters # Name Item Parameters # Name Type props TableProps < Item > Returns # ReactElement < any , string | JSXElementConstructor < any >> asyncInputValidator # \u25b8 asyncInputValidator ( validator ): AsyncInputValidator A helper function to create an AsyncInputValidator Parameters # Name Type validator AsyncInputValidator Returns # AsyncInputValidator createTerminalTab # \u25b8 createTerminalTab ( tabParams? ): Required < DockTabCreate > Parameters # Name Type tabParams? DockTabCreateSpecific Returns # Required < DockTabCreate > getDetailsUrl # \u25b8 getDetailsUrl ( selfLink , resetSelected? , mergeGlobals? ): string Deprecated Use Renderer.Navigation.getDetailsUrl Parameters # Name Type selfLink string resetSelected? boolean mergeGlobals? boolean Returns # string inputValidator # \u25b8 inputValidator ( validator ): SyncInputValidator A helper function to create an SyncInputValidator Parameters # Name Type validator SyncInputValidator Returns # SyncInputValidator isAsyncValidator # \u25b8 isAsyncValidator ( validator ): validator is AsyncInputValidator Parameters # Name Type validator InputValidator < boolean > Returns # validator is AsyncInputValidator isSvg # \u25b8 isSvg ( content ): boolean Parameters # Name Type content string Returns # boolean onMultiSelectFor # \u25b8 onMultiSelectFor < Value , Option , Group >( collection ): SelectProps < Value , Option , true , Group >[ \"onChange\" ] Type parameters # Name Type Value Value Option extends SelectOption < Value , Option > Group extends GroupBase < Option , Group > = GroupBase < Option > Parameters # Name Type collection Set < Value > | ObservableSet < Value > Returns # SelectProps < Value , Option , true , Group >[ \"onChange\" ] showDetails # \u25b8 showDetails ( selfLink , resetSelected? ): void Deprecated Use Renderer.Navigation.showDetails Parameters # Name Type selfLink undefined | string resetSelected? boolean Returns # void unionInputValidatorsAsync # \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 Parameters # Name Type baseValidator Simplify < Except < Pick < InputValidator < boolean >, \"message\" | \"condition\" >, \"message\" > & Required < Pick < Pick < InputValidator < boolean >, \"message\" | \"condition\" >, \"message\" >>> ...validators InputValidator < boolean >[] Returns # AsyncInputValidator withTooltip # \u25b8 withTooltip < TargetProps >( Target ): React.FunctionComponent < TargetProps & TooltipDecoratorProps > Type parameters # Name TargetProps Parameters # Name Type Target TargetProps extends Pick < TooltipDecoratorProps , \"id\" | \"children\" > ? FunctionComponent < TargetProps > : never Returns # React.FunctionComponent < TargetProps & TooltipDecoratorProps >","title":"Namespace: Component"},{"location":"extensions/api/modules/Renderer.Component/#namespace-component","text":"Renderer .Component","title":"Namespace: Component"},{"location":"extensions/api/modules/Renderer.Component/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Renderer.Component/#references","text":"CategoryColumnRegistration","title":"References"},{"location":"extensions/api/modules/Renderer.Component/#enumerations","text":"NotificationStatus TooltipPosition","title":"Enumerations"},{"location":"extensions/api/modules/Renderer.Component/#classes","text":"DrawerParamToggler Input MenuItem NotificationsStore PageLayout SettingLayout Slider Spinner Stepper SubTitle Tab TableCell TableHead TableRow Tabs TerminalStore Tooltip Wizard WizardLayout WizardStep","title":"Classes"},{"location":"extensions/api/modules/Renderer.Component/#interfaces","text":"AdditionalCategoryColumnRegistration BadgeProps BarChartProps BaseIconProps ButtonProps CheckboxProps ConfirmDialogBooleanParams ConfirmDialogParams ConfirmDialogProps CreateNotificationOptions CustomPlaceholderProps DialogProps DrawerItemLabelsProps DrawerItemProps DrawerParamTogglerProps DrawerProps DrawerTitleProps IconDataFnArg IconProps KubeEventDetailsProps KubeObjectDetailsProps KubeObjectListLayoutProps KubeObjectMenuProps KubeObjectMetaProps LineProgressProps MainLayoutProps MenuActionsProps MenuContextValue MenuItemProps MenuPosition MenuProps MenuStyle MonacoEditorProps NamespaceSelectProps Notification PieChartData PieChartProps PodDetailsListProps RadioGroupProps RadioProps SearchInputProps SelectOption SelectProps SettingLayoutProps SliderProps SpinnerProps StatusBrickProps StepperProps SubTitleProps SwitchProps SwitcherProps TabLayoutProps TabLayoutRoute TabProps TableCellProps TableHeadProps TableProps TableRowProps TableSortParams TabsProps TooltipContentFormatters TooltipDecoratorProps TooltipProps WizardCommonProps WizardLayoutProps WizardProps WizardStepProps","title":"Interfaces"},{"location":"extensions/api/modules/Renderer.Component/#type-aliases","text":"DatasetTooltipLabel DrawerPosition IconData InputProps InputValidation InputValidationResult InputValidator LegacyAutoConvertedOptions MonacoCustomTheme MonacoEditorId MonacoTheme NamespaceSelectSort NotificationId NotificationMessage ShowNotification SyncValidationMessage TableCellElem TableHeadElem TableOrderBy TableRowElem TableSortBy TableSortCallback TableSortCallbacks","title":"Type Aliases"},{"location":"extensions/api/modules/Renderer.Component/#variables","text":"CommandOverlay InputValidators MenuContext Notifications cpuOptions logTabStore memoryOptions notificationsStore resizingAnchorProps terminalStore","title":"Variables"},{"location":"extensions/api/modules/Renderer.Component/#functions","text":"Badge BarChart Button Checkbox ConfirmDialog Dialog Drawer DrawerItem DrawerItemLabels DrawerTitle FormSwitch Icon KubeEventDetails KubeObjectDetails KubeObjectListLayout KubeObjectMenu KubeObjectMeta LineProgress MainLayout Menu MenuActions MonacoEditor NamespaceSelect NamespaceSelectFilter PieChart PodDetailsList Radio RadioGroup SearchInput Select StatusBrick SubMenu Switch Switcher TabLayout Table asyncInputValidator createTerminalTab getDetailsUrl inputValidator isAsyncValidator isSvg onMultiSelectFor showDetails unionInputValidatorsAsync withTooltip","title":"Functions"},{"location":"extensions/api/modules/Renderer.Component/#references_1","text":"","title":"References"},{"location":"extensions/api/modules/Renderer.Component/#categorycolumnregistration","text":"Re-exports CategoryColumnRegistration","title":"CategoryColumnRegistration"},{"location":"extensions/api/modules/Renderer.Component/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Renderer.Component/#datasettooltiplabel","text":"\u01ac DatasetTooltipLabel : ( percent : string ) => string | string","title":"DatasetTooltipLabel"},{"location":"extensions/api/modules/Renderer.Component/#drawerposition","text":"\u01ac DrawerPosition : \"top\" | \"left\" | \"right\" | \"bottom\"","title":"DrawerPosition"},{"location":"extensions/api/modules/Renderer.Component/#icondata","text":"\u01ac IconData : string | React.ReactNode | ( opt : IconDataFnArg ) => React.ReactNode One of the folloing: - A material icon name - A react node - Or a function that produces a react node","title":"IconData"},{"location":"extensions/api/modules/Renderer.Component/#inputprops","text":"\u01ac InputProps : Omit < InputElementProps , \"onChange\" | \"onSubmit\" > & { autoSelectOnFocus? : boolean ; blurOnEnter? : boolean ; className? : string ; contentRight? : string | React.ReactNode ; 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 }","title":"InputProps"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidation","text":"\u01ac InputValidation < IsAsync >: ( value : string , props? : InputProps ) => InputValidationResult < IsAsync >","title":"InputValidation"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidationresult","text":"\u01ac InputValidationResult < IsAsync >: IsAsync extends true ? Promise < void > : boolean","title":"InputValidationResult"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidator","text":"\u01ac InputValidator < IsAsync >: SyncInputValidator | AsyncInputValidator | IsAsync extends boolean ? LegacyInputValidator : never","title":"InputValidator"},{"location":"extensions/api/modules/Renderer.Component/#legacyautoconvertedoptions","text":"\u01ac LegacyAutoConvertedOptions : string [] Deprecated This should not be used anymore, convert the options yourself.","title":"LegacyAutoConvertedOptions"},{"location":"extensions/api/modules/Renderer.Component/#monacocustomtheme","text":"\u01ac MonacoCustomTheme : \"clouds-midnight\"","title":"MonacoCustomTheme"},{"location":"extensions/api/modules/Renderer.Component/#monacoeditorid","text":"\u01ac MonacoEditorId : string","title":"MonacoEditorId"},{"location":"extensions/api/modules/Renderer.Component/#monacotheme","text":"\u01ac MonacoTheme : \"vs\" | \"vs-dark\" | \"hc-black\" | MonacoCustomTheme","title":"MonacoTheme"},{"location":"extensions/api/modules/Renderer.Component/#namespaceselectsort","text":"\u01ac NamespaceSelectSort : ( left : string , right : string ) => number","title":"NamespaceSelectSort"},{"location":"extensions/api/modules/Renderer.Component/#notificationid","text":"\u01ac NotificationId : string | number","title":"NotificationId"},{"location":"extensions/api/modules/Renderer.Component/#notificationmessage","text":"\u01ac NotificationMessage : string | React.ReactElement | React.ReactElement [] | JsonApiErrorParsed | Error","title":"NotificationMessage"},{"location":"extensions/api/modules/Renderer.Component/#shownotification","text":"\u01ac ShowNotification : ( message : NotificationMessage , opts? : CreateNotificationOptions ) => Disposer","title":"ShowNotification"},{"location":"extensions/api/modules/Renderer.Component/#syncvalidationmessage","text":"\u01ac SyncValidationMessage : React.ReactNode | ( value : string , props? : InputProps ) => React.ReactNode","title":"SyncValidationMessage"},{"location":"extensions/api/modules/Renderer.Component/#tablecellelem","text":"\u01ac TableCellElem : React.ReactElement < TableCellProps >","title":"TableCellElem"},{"location":"extensions/api/modules/Renderer.Component/#tableheadelem","text":"\u01ac TableHeadElem : React.ReactElement < TableHeadProps >","title":"TableHeadElem"},{"location":"extensions/api/modules/Renderer.Component/#tableorderby","text":"\u01ac TableOrderBy : \"asc\" | \"desc\"","title":"TableOrderBy"},{"location":"extensions/api/modules/Renderer.Component/#tablerowelem","text":"\u01ac TableRowElem < Item >: React.ReactElement < TableRowProps < Item >>","title":"TableRowElem"},{"location":"extensions/api/modules/Renderer.Component/#tablesortby","text":"\u01ac TableSortBy : string","title":"TableSortBy"},{"location":"extensions/api/modules/Renderer.Component/#tablesortcallback","text":"\u01ac TableSortCallback < Item >: ( data : Item ) => undefined | string | number | ( string | number )[]","title":"TableSortCallback"},{"location":"extensions/api/modules/Renderer.Component/#tablesortcallbacks","text":"\u01ac TableSortCallbacks < Item >: Record < string , TableSortCallback < Item >>","title":"TableSortCallbacks"},{"location":"extensions/api/modules/Renderer.Component/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Renderer.Component/#commandoverlay","text":"\u2022 Const CommandOverlay : CommandOverlay","title":"CommandOverlay"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidators","text":"\u2022 Const InputValidators : Object","title":"InputValidators"},{"location":"extensions/api/modules/Renderer.Component/#menucontext","text":"\u2022 Const MenuContext : React.Context < MenuContextValue | null >","title":"MenuContext"},{"location":"extensions/api/modules/Renderer.Component/#notifications","text":"\u2022 Const Notifications : Object","title":"Notifications"},{"location":"extensions/api/modules/Renderer.Component/#cpuoptions","text":"\u2022 Const cpuOptions : ChartOptions","title":"cpuOptions"},{"location":"extensions/api/modules/Renderer.Component/#logtabstore","text":"\u2022 Const logTabStore : LogTabStore & { createPodTab : ( { selectedPod, selectedContainer } : PodLogsTabData ) => string ; createWorkloadTab : ( { workload } : WorkloadLogsTabData ) => string | undefined ; renameTab : ( tabId : string ) => void ; tabs : undefined }","title":"logTabStore"},{"location":"extensions/api/modules/Renderer.Component/#memoryoptions","text":"\u2022 Const memoryOptions : ChartOptions","title":"memoryOptions"},{"location":"extensions/api/modules/Renderer.Component/#notificationsstore","text":"\u2022 Const notificationsStore : NotificationsStore","title":"notificationsStore"},{"location":"extensions/api/modules/Renderer.Component/#resizinganchorprops","text":"\u2022 Const resizingAnchorProps : Record < DrawerPosition , [ ResizeDirection , ResizeSide , ResizeGrowthDirection ]>","title":"resizingAnchorProps"},{"location":"extensions/api/modules/Renderer.Component/#terminalstore","text":"\u2022 Const terminalStore : TerminalStore & { sendCommand : SendCommand }","title":"terminalStore"},{"location":"extensions/api/modules/Renderer.Component/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Renderer.Component/#badge","text":"\u25b8 Badge ( props , context? ): null | ReactElement < any , any >","title":"Badge"},{"location":"extensions/api/modules/Renderer.Component/#barchart","text":"\u25b8 BarChart ( props , context? ): null | ReactElement < any , any >","title":"BarChart"},{"location":"extensions/api/modules/Renderer.Component/#button","text":"\u25b8 Button ( props , context? ): null | ReactElement < any , any >","title":"Button"},{"location":"extensions/api/modules/Renderer.Component/#checkbox","text":"\u25b8 Checkbox ( \u00abdestructured\u00bb ): JSX.Element","title":"Checkbox"},{"location":"extensions/api/modules/Renderer.Component/#confirmdialog","text":"\u25b8 ConfirmDialog ( props , context? ): null | ReactElement < any , any >","title":"ConfirmDialog"},{"location":"extensions/api/modules/Renderer.Component/#dialog","text":"\u25b8 Dialog ( props , context? ): null | ReactElement < any , any >","title":"Dialog"},{"location":"extensions/api/modules/Renderer.Component/#drawer","text":"\u25b8 Drawer ( props , context? ): null | ReactElement < any , any >","title":"Drawer"},{"location":"extensions/api/modules/Renderer.Component/#draweritem","text":"\u25b8 DrawerItem ( \u00abdestructured\u00bb ): JSX.Element | null","title":"DrawerItem"},{"location":"extensions/api/modules/Renderer.Component/#draweritemlabels","text":"\u25b8 DrawerItemLabels ( props ): JSX.Element | null","title":"DrawerItemLabels"},{"location":"extensions/api/modules/Renderer.Component/#drawertitle","text":"\u25b8 DrawerTitle ( \u00abdestructured\u00bb ): JSX.Element","title":"DrawerTitle"},{"location":"extensions/api/modules/Renderer.Component/#formswitch","text":"\u25b8 FormSwitch ( props ): React.FunctionComponentElement < any > Deprecated Use instead from \"../switch.tsx\".","title":"FormSwitch"},{"location":"extensions/api/modules/Renderer.Component/#icon","text":"\u25b8 Icon ( props , context? ): null | ReactElement < any , any >","title":"Icon"},{"location":"extensions/api/modules/Renderer.Component/#kubeeventdetails","text":"\u25b8 KubeEventDetails ( props , context? ): null | ReactElement < any , any >","title":"KubeEventDetails"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectdetails","text":"\u25b8 KubeObjectDetails ( props , context? ): null | ReactElement < any , any >","title":"KubeObjectDetails"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectlistlayout","text":"\u25b8 KubeObjectListLayout < K , A , D >( props ): ReactElement < any , string | JSXElementConstructor < any >>","title":"KubeObjectListLayout"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectmenu","text":"\u25b8 KubeObjectMenu < T >( props ): ReactElement < any , string | JSXElementConstructor < any >>","title":"KubeObjectMenu"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectmeta","text":"\u25b8 KubeObjectMeta ( props , context? ): null | ReactElement < any , any >","title":"KubeObjectMeta"},{"location":"extensions/api/modules/Renderer.Component/#lineprogress","text":"\u25b8 LineProgress ( props , context? ): null | ReactElement < any , any >","title":"LineProgress"},{"location":"extensions/api/modules/Renderer.Component/#mainlayout","text":"\u25b8 MainLayout ( props , context? ): null | ReactElement < any , any >","title":"MainLayout"},{"location":"extensions/api/modules/Renderer.Component/#menu","text":"\u25b8 Menu ( props , context? ): null | ReactElement < any , any >","title":"Menu"},{"location":"extensions/api/modules/Renderer.Component/#menuactions","text":"\u25b8 MenuActions ( props , context? ): null | ReactElement < any , any >","title":"MenuActions"},{"location":"extensions/api/modules/Renderer.Component/#monacoeditor","text":"\u25b8 MonacoEditor ( props ): null | ReactElement < any , string | JSXElementConstructor < any >> NOTE : Exotic components are not callable.","title":"MonacoEditor"},{"location":"extensions/api/modules/Renderer.Component/#namespaceselect","text":"\u25b8 NamespaceSelect < IsMulti >( props ): JSX.Element","title":"NamespaceSelect"},{"location":"extensions/api/modules/Renderer.Component/#namespaceselectfilter","text":"\u25b8 NamespaceSelectFilter ( props , context? ): null | ReactElement < any , any >","title":"NamespaceSelectFilter"},{"location":"extensions/api/modules/Renderer.Component/#piechart","text":"\u25b8 PieChart ( props , context? ): null | ReactElement < any , any >","title":"PieChart"},{"location":"extensions/api/modules/Renderer.Component/#poddetailslist","text":"\u25b8 PodDetailsList ( props , context? ): null | ReactElement < any , any >","title":"PodDetailsList"},{"location":"extensions/api/modules/Renderer.Component/#radio","text":"\u25b8 Radio < T >( \u00abdestructured\u00bb ): JSX.Element","title":"Radio"},{"location":"extensions/api/modules/Renderer.Component/#radiogroup","text":"\u25b8 RadioGroup < T >( \u00abdestructured\u00bb ): JSX.Element","title":"RadioGroup"},{"location":"extensions/api/modules/Renderer.Component/#searchinput","text":"\u25b8 SearchInput ( props , context? ): null | ReactElement < any , any >","title":"SearchInput"},{"location":"extensions/api/modules/Renderer.Component/#select","text":"\u25b8 Select < Value , Option , IsMulti , Group >( props ): ReactElement < any , string | JSXElementConstructor < any >>","title":"Select"},{"location":"extensions/api/modules/Renderer.Component/#statusbrick","text":"\u25b8 StatusBrick ( props , context? ): null | ReactElement < any , any >","title":"StatusBrick"},{"location":"extensions/api/modules/Renderer.Component/#submenu","text":"\u25b8 SubMenu ( props ): JSX.Element","title":"SubMenu"},{"location":"extensions/api/modules/Renderer.Component/#switch","text":"\u25b8 Switch ( \u00abdestructured\u00bb ): JSX.Element","title":"Switch"},{"location":"extensions/api/modules/Renderer.Component/#switcher","text":"\u25b8 Switcher ( \u00abdestructured\u00bb ): JSX.Element Deprecated Use instead from \"../switch.tsx\".","title":"Switcher"},{"location":"extensions/api/modules/Renderer.Component/#tablayout","text":"\u25b8 TabLayout ( props , context? ): null | ReactElement < any , any >","title":"TabLayout"},{"location":"extensions/api/modules/Renderer.Component/#table","text":"\u25b8 Table < Item >( props ): ReactElement < any , string | JSXElementConstructor < any >>","title":"Table"},{"location":"extensions/api/modules/Renderer.Component/#asyncinputvalidator","text":"\u25b8 asyncInputValidator ( validator ): AsyncInputValidator A helper function to create an AsyncInputValidator","title":"asyncInputValidator"},{"location":"extensions/api/modules/Renderer.Component/#createterminaltab","text":"\u25b8 createTerminalTab ( tabParams? ): Required < DockTabCreate >","title":"createTerminalTab"},{"location":"extensions/api/modules/Renderer.Component/#getdetailsurl","text":"\u25b8 getDetailsUrl ( selfLink , resetSelected? , mergeGlobals? ): string Deprecated Use Renderer.Navigation.getDetailsUrl","title":"getDetailsUrl"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidator_1","text":"\u25b8 inputValidator ( validator ): SyncInputValidator A helper function to create an SyncInputValidator","title":"inputValidator"},{"location":"extensions/api/modules/Renderer.Component/#isasyncvalidator","text":"\u25b8 isAsyncValidator ( validator ): validator is AsyncInputValidator","title":"isAsyncValidator"},{"location":"extensions/api/modules/Renderer.Component/#issvg","text":"\u25b8 isSvg ( content ): boolean","title":"isSvg"},{"location":"extensions/api/modules/Renderer.Component/#onmultiselectfor","text":"\u25b8 onMultiSelectFor < Value , Option , Group >( collection ): SelectProps < Value , Option , true , Group >[ \"onChange\" ]","title":"onMultiSelectFor"},{"location":"extensions/api/modules/Renderer.Component/#showdetails","text":"\u25b8 showDetails ( selfLink , resetSelected? ): void Deprecated Use Renderer.Navigation.showDetails","title":"showDetails"},{"location":"extensions/api/modules/Renderer.Component/#unioninputvalidatorsasync","text":"\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","title":"unionInputValidatorsAsync"},{"location":"extensions/api/modules/Renderer.Component/#withtooltip","text":"\u25b8 withTooltip < TargetProps >( Target ): React.FunctionComponent < TargetProps & TooltipDecoratorProps >","title":"withTooltip"},{"location":"extensions/api/modules/Renderer.K8sApi/","text":"Namespace: K8sApi # Renderer .K8sApi Table of contents # References # BaseKubeJsonApiObjectMetadata ClusterRole ClusterRoleBinding ClusterScopedMetadata ConfigMap CronJob CustomResourceDefinition DaemonSet Deployment Endpoint HorizontalPodAutoscaler HorizontalPodAutoscalerStore ILocalKubeApiConfig IPodContainer IPodContainerStatus IRemoteKubeApiConfig ISecretRef Ingress Job JsonPatch KubeEvent KubeJsonApiData KubeJsonApiDataFor KubeJsonApiObjectMetadata KubeObject KubeObjectMetadata KubeObjectStoreLoadAllParams KubeObjectStoreLoadingParams KubeObjectStoreSubscribeParams KubeStatus KubeStatusData LimitRange Namespace NamespaceScopedMetadata NetworkPolicy Node OwnerReference PersistentVolume PersistentVolumeClaim Pod PodDisruptionBudget PriorityClass ReplicaSet ResourceQuota Role RoleBinding Secret Service ServiceAccount StatefulSet StorageClass Enumerations # KubeObjectStatusLevel Classes # CRDResourceStore CRDStore ConfigMapsStore CronJobStore DaemonSetStore DeploymentStore EndpointStore EventStore HPAStore IngressClassStore IngressStore JobStore KubeObjectStore LimitRangesStore NamespaceStore NetworkPolicyStore NodesStore PersistentVolumesStore PodDisruptionBudgetsStore PodsStore PriorityClassStoreStore ReplicaSetStore ResourceQuotasStore ResourceStack RoleBindingsStore RolesStore SecretsStore ServiceAccountsStore ServiceStore StatefulSetStore StorageClassStore VerticalPodAutoscalerStore VolumeClaimStore Interfaces # IKubeApiCluster IgnoredKubeApiOptions KubeObjectStatus Type Aliases # DeploymentApi IngressApi KubeApi KubeJsonApi NodesApi PersistentVolumeClaimsApi PodsApi Variables # DeploymentApi IngressApi KubeApi KubeJsonApi NodesApi PersistentVolumeClaimsApi PodsApi apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi hpaApi ingressApi jobApi limitRangeApi namespacesApi networkPolicyApi nodesApi pcApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi vpaApi Functions # createResourceStack forCluster forRemoteCluster isAllowedResource References # BaseKubeJsonApiObjectMetadata # Re-exports BaseKubeJsonApiObjectMetadata ClusterRole # Re-exports ClusterRole ClusterRoleBinding # Re-exports ClusterRoleBinding ClusterScopedMetadata # Re-exports ClusterScopedMetadata ConfigMap # Re-exports ConfigMap CronJob # Re-exports CronJob CustomResourceDefinition # Re-exports CustomResourceDefinition DaemonSet # Re-exports DaemonSet Deployment # Re-exports Deployment Endpoint # Re-exports Endpoint HorizontalPodAutoscaler # Re-exports HorizontalPodAutoscaler HorizontalPodAutoscalerStore # Renames and re-exports HPAStore ILocalKubeApiConfig # Re-exports ILocalKubeApiConfig IPodContainer # Re-exports IPodContainer IPodContainerStatus # Re-exports IPodContainerStatus IRemoteKubeApiConfig # Re-exports IRemoteKubeApiConfig ISecretRef # Re-exports ISecretRef Ingress # Re-exports Ingress Job # Re-exports Job JsonPatch # Re-exports JsonPatch KubeEvent # Re-exports KubeEvent KubeJsonApiData # Re-exports KubeJsonApiData KubeJsonApiDataFor # Re-exports KubeJsonApiDataFor KubeJsonApiObjectMetadata # Re-exports KubeJsonApiObjectMetadata KubeObject # Re-exports KubeObject KubeObjectMetadata # Re-exports KubeObjectMetadata KubeObjectStoreLoadAllParams # Re-exports KubeObjectStoreLoadAllParams KubeObjectStoreLoadingParams # Re-exports KubeObjectStoreLoadingParams KubeObjectStoreSubscribeParams # Re-exports KubeObjectStoreSubscribeParams KubeStatus # Re-exports KubeStatus KubeStatusData # Re-exports KubeStatusData LimitRange # Re-exports LimitRange Namespace # Re-exports Namespace NamespaceScopedMetadata # Re-exports NamespaceScopedMetadata NetworkPolicy # Re-exports NetworkPolicy Node # Re-exports Node OwnerReference # Re-exports OwnerReference PersistentVolume # Re-exports PersistentVolume PersistentVolumeClaim # Re-exports PersistentVolumeClaim Pod # Re-exports Pod PodDisruptionBudget # Re-exports PodDisruptionBudget PriorityClass # Re-exports PriorityClass ReplicaSet # Re-exports ReplicaSet ResourceQuota # Re-exports ResourceQuota Role # Re-exports Role RoleBinding # Re-exports RoleBinding Secret # Re-exports Secret Service # Re-exports Service ServiceAccount # Re-exports ServiceAccount StatefulSet # Re-exports StatefulSet StorageClass # Re-exports StorageClass Type Aliases # DeploymentApi # \u01ac DeploymentApi : InternalDeploymentApi IngressApi # \u01ac IngressApi : InternalIngressApi KubeApi # \u01ac KubeApi < Object , Data >: InternalKubeApi < Object , Data > Type parameters # Name Type Object extends KubeObject = KubeObject Data extends KubeJsonApiDataFor < Object > = KubeJsonApiDataFor < Object > KubeJsonApi # \u01ac KubeJsonApi : InternalKubeJsonApi NodesApi # \u01ac NodesApi : NodeApi PersistentVolumeClaimsApi # \u01ac PersistentVolumeClaimsApi : PersistentVolumeClaimApi PodsApi # \u01ac PodsApi : PodApi Variables # DeploymentApi # \u2022 DeploymentApi : ( opts? : DerivedKubeApiOptions ) => DeploymentApi Type declaration # \u2022 new DeploymentApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions IngressApi # \u2022 IngressApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => IngressApi Type declaration # \u2022 new IngressApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions KubeApi # \u2022 KubeApi : ( opts : KubeApiOptions < Object_1 , Data >) => KubeApi < Object_1 , Data > Type declaration # \u2022 new KubeApi < Object_1 , Data >( opts ) Type parameters # Name Type 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 > Parameters # Name Type opts KubeApiOptions < Object_1 , Data > KubeJsonApi # \u2022 KubeJsonApi : ( config : JsonApiConfig , reqInit? : RequestInit ) => KubeJsonApi & { forCluster : CreateKubeJsonApiForCluster } NodesApi # \u2022 NodesApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => NodeApi Type declaration # \u2022 new NodesApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions PersistentVolumeClaimsApi # \u2022 PersistentVolumeClaimsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PersistentVolumeClaimApi Type declaration # \u2022 new PersistentVolumeClaimsApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions PodsApi # \u2022 PodsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PodApi Type declaration # \u2022 new PodsApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions apiManager # \u2022 Const apiManager : ApiManager clusterRoleApi # \u2022 Const clusterRoleApi : ClusterRoleApi clusterRoleBindingApi # \u2022 Const clusterRoleBindingApi : ClusterRoleBindingApi configMapApi # \u2022 Const configMapApi : ConfigMapApi crdApi # \u2022 Const crdApi : CustomResourceDefinitionApi cronJobApi # \u2022 Const cronJobApi : CronJobApi daemonSetApi # \u2022 Const daemonSetApi : DaemonSetApi deploymentApi # \u2022 Const deploymentApi : DeploymentApi endpointApi # \u2022 Const endpointApi : EndpointsApi eventApi # \u2022 Const eventApi : KubeEventApi hpaApi # \u2022 Const hpaApi : HorizontalPodAutoscalerApi ingressApi # \u2022 Const ingressApi : IngressApi jobApi # \u2022 Const jobApi : JobApi limitRangeApi # \u2022 Const limitRangeApi : LimitRangeApi namespacesApi # \u2022 Const namespacesApi : NamespaceApi networkPolicyApi # \u2022 Const networkPolicyApi : NetworkPolicyApi nodesApi # \u2022 Const nodesApi : NodeApi pcApi # \u2022 Const pcApi : PriorityClassApi pdbApi # \u2022 Const pdbApi : PodDisruptionBudgetApi persistentVolumeApi # \u2022 Const persistentVolumeApi : PersistentVolumeApi podsApi # \u2022 Const podsApi : PodApi pvcApi # \u2022 Const pvcApi : PersistentVolumeClaimApi replicaSetApi # \u2022 Const replicaSetApi : ReplicaSetApi resourceQuotaApi # \u2022 Const resourceQuotaApi : ResourceQuotaApi roleApi # \u2022 Const roleApi : RoleApi roleBindingApi # \u2022 Const roleBindingApi : RoleBindingApi secretsApi # \u2022 Const secretsApi : SecretApi serviceAccountsApi # \u2022 Const serviceAccountsApi : ServiceAccountApi serviceApi # \u2022 Const serviceApi : ServiceApi statefulSetApi # \u2022 Const statefulSetApi : StatefulSetApi storageClassApi # \u2022 Const storageClassApi : StorageClassApi vpaApi # \u2022 Const vpaApi : VerticalPodAutoscalerApi Functions # createResourceStack # \u25b8 createResourceStack ( cluster , name ): ResourceApplyingStack Parameters # Name Type cluster KubernetesCluster < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > name string Returns # ResourceApplyingStack forCluster # \u25b8 forCluster < Object , Api , Data >( cluster , kubeClass , apiClass ): Api Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Api extends KubeApi < Object , KubeJsonApiDataFor < Object >, Api > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type cluster ILocalKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass KubeApiConstructor < Object , Api > Returns # Api \u25b8 forCluster < Object , Data >( cluster , kubeClass , apiClass? ): KubeApi < Object , KubeJsonApiDataFor < Object >> Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type cluster ILocalKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass? KubeApiConstructor < Object , KubeApi < Object , KubeJsonApiDataFor < Object >>> Returns # KubeApi < Object , KubeJsonApiDataFor < Object >> forRemoteCluster # \u25b8 forRemoteCluster < Object , Api , Data >( config , kubeClass , apiClass ): Api Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Api extends KubeApi < Object , KubeJsonApiDataFor < Object >, Api > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type config IRemoteKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass KubeApiConstructor < Object , Api > Returns # Api \u25b8 forRemoteCluster < Object , Data >( config , kubeClass , apiClass? ): KubeApi < Object , KubeJsonApiDataFor < Object >> Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type config IRemoteKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass? KubeApiConstructor < Object , KubeApi < Object , KubeJsonApiDataFor < Object >>> Returns # KubeApi < Object , KubeJsonApiDataFor < Object >> isAllowedResource # \u25b8 isAllowedResource ( resources ): boolean Parameters # Name Type resources KubeResource | KubeResource [] Returns # boolean","title":"Namespace: K8sApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespace-k8sapi","text":"Renderer .K8sApi","title":"Namespace: K8sApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Renderer.K8sApi/#references","text":"BaseKubeJsonApiObjectMetadata ClusterRole ClusterRoleBinding ClusterScopedMetadata ConfigMap CronJob CustomResourceDefinition DaemonSet Deployment Endpoint HorizontalPodAutoscaler HorizontalPodAutoscalerStore ILocalKubeApiConfig IPodContainer IPodContainerStatus IRemoteKubeApiConfig ISecretRef Ingress Job JsonPatch KubeEvent KubeJsonApiData KubeJsonApiDataFor KubeJsonApiObjectMetadata KubeObject KubeObjectMetadata KubeObjectStoreLoadAllParams KubeObjectStoreLoadingParams KubeObjectStoreSubscribeParams KubeStatus KubeStatusData LimitRange Namespace NamespaceScopedMetadata NetworkPolicy Node OwnerReference PersistentVolume PersistentVolumeClaim Pod PodDisruptionBudget PriorityClass ReplicaSet ResourceQuota Role RoleBinding Secret Service ServiceAccount StatefulSet StorageClass","title":"References"},{"location":"extensions/api/modules/Renderer.K8sApi/#enumerations","text":"KubeObjectStatusLevel","title":"Enumerations"},{"location":"extensions/api/modules/Renderer.K8sApi/#classes","text":"CRDResourceStore CRDStore ConfigMapsStore CronJobStore DaemonSetStore DeploymentStore EndpointStore EventStore HPAStore IngressClassStore IngressStore JobStore KubeObjectStore LimitRangesStore NamespaceStore NetworkPolicyStore NodesStore PersistentVolumesStore PodDisruptionBudgetsStore PodsStore PriorityClassStoreStore ReplicaSetStore ResourceQuotasStore ResourceStack RoleBindingsStore RolesStore SecretsStore ServiceAccountsStore ServiceStore StatefulSetStore StorageClassStore VerticalPodAutoscalerStore VolumeClaimStore","title":"Classes"},{"location":"extensions/api/modules/Renderer.K8sApi/#interfaces","text":"IKubeApiCluster IgnoredKubeApiOptions KubeObjectStatus","title":"Interfaces"},{"location":"extensions/api/modules/Renderer.K8sApi/#type-aliases","text":"DeploymentApi IngressApi KubeApi KubeJsonApi NodesApi PersistentVolumeClaimsApi PodsApi","title":"Type Aliases"},{"location":"extensions/api/modules/Renderer.K8sApi/#variables","text":"DeploymentApi IngressApi KubeApi KubeJsonApi NodesApi PersistentVolumeClaimsApi PodsApi apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi hpaApi ingressApi jobApi limitRangeApi namespacesApi networkPolicyApi nodesApi pcApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi vpaApi","title":"Variables"},{"location":"extensions/api/modules/Renderer.K8sApi/#functions","text":"createResourceStack forCluster forRemoteCluster isAllowedResource","title":"Functions"},{"location":"extensions/api/modules/Renderer.K8sApi/#references_1","text":"","title":"References"},{"location":"extensions/api/modules/Renderer.K8sApi/#basekubejsonapiobjectmetadata","text":"Re-exports BaseKubeJsonApiObjectMetadata","title":"BaseKubeJsonApiObjectMetadata"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterrole","text":"Re-exports ClusterRole","title":"ClusterRole"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterrolebinding","text":"Re-exports ClusterRoleBinding","title":"ClusterRoleBinding"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterscopedmetadata","text":"Re-exports ClusterScopedMetadata","title":"ClusterScopedMetadata"},{"location":"extensions/api/modules/Renderer.K8sApi/#configmap","text":"Re-exports ConfigMap","title":"ConfigMap"},{"location":"extensions/api/modules/Renderer.K8sApi/#cronjob","text":"Re-exports CronJob","title":"CronJob"},{"location":"extensions/api/modules/Renderer.K8sApi/#customresourcedefinition","text":"Re-exports CustomResourceDefinition","title":"CustomResourceDefinition"},{"location":"extensions/api/modules/Renderer.K8sApi/#daemonset","text":"Re-exports DaemonSet","title":"DaemonSet"},{"location":"extensions/api/modules/Renderer.K8sApi/#deployment","text":"Re-exports Deployment","title":"Deployment"},{"location":"extensions/api/modules/Renderer.K8sApi/#endpoint","text":"Re-exports Endpoint","title":"Endpoint"},{"location":"extensions/api/modules/Renderer.K8sApi/#horizontalpodautoscaler","text":"Re-exports HorizontalPodAutoscaler","title":"HorizontalPodAutoscaler"},{"location":"extensions/api/modules/Renderer.K8sApi/#horizontalpodautoscalerstore","text":"Renames and re-exports HPAStore","title":"HorizontalPodAutoscalerStore"},{"location":"extensions/api/modules/Renderer.K8sApi/#ilocalkubeapiconfig","text":"Re-exports ILocalKubeApiConfig","title":"ILocalKubeApiConfig"},{"location":"extensions/api/modules/Renderer.K8sApi/#ipodcontainer","text":"Re-exports IPodContainer","title":"IPodContainer"},{"location":"extensions/api/modules/Renderer.K8sApi/#ipodcontainerstatus","text":"Re-exports IPodContainerStatus","title":"IPodContainerStatus"},{"location":"extensions/api/modules/Renderer.K8sApi/#iremotekubeapiconfig","text":"Re-exports IRemoteKubeApiConfig","title":"IRemoteKubeApiConfig"},{"location":"extensions/api/modules/Renderer.K8sApi/#isecretref","text":"Re-exports ISecretRef","title":"ISecretRef"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingress","text":"Re-exports Ingress","title":"Ingress"},{"location":"extensions/api/modules/Renderer.K8sApi/#job","text":"Re-exports Job","title":"Job"},{"location":"extensions/api/modules/Renderer.K8sApi/#jsonpatch","text":"Re-exports JsonPatch","title":"JsonPatch"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeevent","text":"Re-exports KubeEvent","title":"KubeEvent"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapidata","text":"Re-exports KubeJsonApiData","title":"KubeJsonApiData"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapidatafor","text":"Re-exports KubeJsonApiDataFor","title":"KubeJsonApiDataFor"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapiobjectmetadata","text":"Re-exports KubeJsonApiObjectMetadata","title":"KubeJsonApiObjectMetadata"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobject","text":"Re-exports KubeObject","title":"KubeObject"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectmetadata","text":"Re-exports KubeObjectMetadata","title":"KubeObjectMetadata"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstoreloadallparams","text":"Re-exports KubeObjectStoreLoadAllParams","title":"KubeObjectStoreLoadAllParams"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstoreloadingparams","text":"Re-exports KubeObjectStoreLoadingParams","title":"KubeObjectStoreLoadingParams"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstoresubscribeparams","text":"Re-exports KubeObjectStoreSubscribeParams","title":"KubeObjectStoreSubscribeParams"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubestatus","text":"Re-exports KubeStatus","title":"KubeStatus"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubestatusdata","text":"Re-exports KubeStatusData","title":"KubeStatusData"},{"location":"extensions/api/modules/Renderer.K8sApi/#limitrange","text":"Re-exports LimitRange","title":"LimitRange"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespace","text":"Re-exports Namespace","title":"Namespace"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespacescopedmetadata","text":"Re-exports NamespaceScopedMetadata","title":"NamespaceScopedMetadata"},{"location":"extensions/api/modules/Renderer.K8sApi/#networkpolicy","text":"Re-exports NetworkPolicy","title":"NetworkPolicy"},{"location":"extensions/api/modules/Renderer.K8sApi/#node","text":"Re-exports Node","title":"Node"},{"location":"extensions/api/modules/Renderer.K8sApi/#ownerreference","text":"Re-exports OwnerReference","title":"OwnerReference"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolume","text":"Re-exports PersistentVolume","title":"PersistentVolume"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeclaim","text":"Re-exports PersistentVolumeClaim","title":"PersistentVolumeClaim"},{"location":"extensions/api/modules/Renderer.K8sApi/#pod","text":"Re-exports Pod","title":"Pod"},{"location":"extensions/api/modules/Renderer.K8sApi/#poddisruptionbudget","text":"Re-exports PodDisruptionBudget","title":"PodDisruptionBudget"},{"location":"extensions/api/modules/Renderer.K8sApi/#priorityclass","text":"Re-exports PriorityClass","title":"PriorityClass"},{"location":"extensions/api/modules/Renderer.K8sApi/#replicaset","text":"Re-exports ReplicaSet","title":"ReplicaSet"},{"location":"extensions/api/modules/Renderer.K8sApi/#resourcequota","text":"Re-exports ResourceQuota","title":"ResourceQuota"},{"location":"extensions/api/modules/Renderer.K8sApi/#role","text":"Re-exports Role","title":"Role"},{"location":"extensions/api/modules/Renderer.K8sApi/#rolebinding","text":"Re-exports RoleBinding","title":"RoleBinding"},{"location":"extensions/api/modules/Renderer.K8sApi/#secret","text":"Re-exports Secret","title":"Secret"},{"location":"extensions/api/modules/Renderer.K8sApi/#service","text":"Re-exports Service","title":"Service"},{"location":"extensions/api/modules/Renderer.K8sApi/#serviceaccount","text":"Re-exports ServiceAccount","title":"ServiceAccount"},{"location":"extensions/api/modules/Renderer.K8sApi/#statefulset","text":"Re-exports StatefulSet","title":"StatefulSet"},{"location":"extensions/api/modules/Renderer.K8sApi/#storageclass","text":"Re-exports StorageClass","title":"StorageClass"},{"location":"extensions/api/modules/Renderer.K8sApi/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Renderer.K8sApi/#deploymentapi","text":"\u01ac DeploymentApi : InternalDeploymentApi","title":"DeploymentApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingressapi","text":"\u01ac IngressApi : InternalIngressApi","title":"IngressApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeapi","text":"\u01ac KubeApi < Object , Data >: InternalKubeApi < Object , Data >","title":"KubeApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapi","text":"\u01ac KubeJsonApi : InternalKubeJsonApi","title":"KubeJsonApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#nodesapi","text":"\u01ac NodesApi : NodeApi","title":"NodesApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeclaimsapi","text":"\u01ac PersistentVolumeClaimsApi : PersistentVolumeClaimApi","title":"PersistentVolumeClaimsApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#podsapi","text":"\u01ac PodsApi : PodApi","title":"PodsApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Renderer.K8sApi/#deploymentapi_1","text":"\u2022 DeploymentApi : ( opts? : DerivedKubeApiOptions ) => DeploymentApi","title":"DeploymentApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingressapi_1","text":"\u2022 IngressApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => IngressApi","title":"IngressApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeapi_1","text":"\u2022 KubeApi : ( opts : KubeApiOptions < Object_1 , Data >) => KubeApi < Object_1 , Data >","title":"KubeApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapi_1","text":"\u2022 KubeJsonApi : ( config : JsonApiConfig , reqInit? : RequestInit ) => KubeJsonApi & { forCluster : CreateKubeJsonApiForCluster }","title":"KubeJsonApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#nodesapi_1","text":"\u2022 NodesApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => NodeApi","title":"NodesApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeclaimsapi_1","text":"\u2022 PersistentVolumeClaimsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PersistentVolumeClaimApi","title":"PersistentVolumeClaimsApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#podsapi_1","text":"\u2022 PodsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PodApi","title":"PodsApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#apimanager","text":"\u2022 Const apiManager : ApiManager","title":"apiManager"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterroleapi","text":"\u2022 Const clusterRoleApi : ClusterRoleApi","title":"clusterRoleApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterrolebindingapi","text":"\u2022 Const clusterRoleBindingApi : ClusterRoleBindingApi","title":"clusterRoleBindingApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#configmapapi","text":"\u2022 Const configMapApi : ConfigMapApi","title":"configMapApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#crdapi","text":"\u2022 Const crdApi : CustomResourceDefinitionApi","title":"crdApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#cronjobapi","text":"\u2022 Const cronJobApi : CronJobApi","title":"cronJobApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#daemonsetapi","text":"\u2022 Const daemonSetApi : DaemonSetApi","title":"daemonSetApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#deploymentapi_2","text":"\u2022 Const deploymentApi : DeploymentApi","title":"deploymentApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#endpointapi","text":"\u2022 Const endpointApi : EndpointsApi","title":"endpointApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#eventapi","text":"\u2022 Const eventApi : KubeEventApi","title":"eventApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#hpaapi","text":"\u2022 Const hpaApi : HorizontalPodAutoscalerApi","title":"hpaApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingressapi_2","text":"\u2022 Const ingressApi : IngressApi","title":"ingressApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#jobapi","text":"\u2022 Const jobApi : JobApi","title":"jobApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#limitrangeapi","text":"\u2022 Const limitRangeApi : LimitRangeApi","title":"limitRangeApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespacesapi","text":"\u2022 Const namespacesApi : NamespaceApi","title":"namespacesApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#networkpolicyapi","text":"\u2022 Const networkPolicyApi : NetworkPolicyApi","title":"networkPolicyApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#nodesapi_2","text":"\u2022 Const nodesApi : NodeApi","title":"nodesApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#pcapi","text":"\u2022 Const pcApi : PriorityClassApi","title":"pcApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#pdbapi","text":"\u2022 Const pdbApi : PodDisruptionBudgetApi","title":"pdbApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeapi","text":"\u2022 Const persistentVolumeApi : PersistentVolumeApi","title":"persistentVolumeApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#podsapi_2","text":"\u2022 Const podsApi : PodApi","title":"podsApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#pvcapi","text":"\u2022 Const pvcApi : PersistentVolumeClaimApi","title":"pvcApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#replicasetapi","text":"\u2022 Const replicaSetApi : ReplicaSetApi","title":"replicaSetApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#resourcequotaapi","text":"\u2022 Const resourceQuotaApi : ResourceQuotaApi","title":"resourceQuotaApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#roleapi","text":"\u2022 Const roleApi : RoleApi","title":"roleApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#rolebindingapi","text":"\u2022 Const roleBindingApi : RoleBindingApi","title":"roleBindingApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#secretsapi","text":"\u2022 Const secretsApi : SecretApi","title":"secretsApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#serviceaccountsapi","text":"\u2022 Const serviceAccountsApi : ServiceAccountApi","title":"serviceAccountsApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#serviceapi","text":"\u2022 Const serviceApi : ServiceApi","title":"serviceApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#statefulsetapi","text":"\u2022 Const statefulSetApi : StatefulSetApi","title":"statefulSetApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#storageclassapi","text":"\u2022 Const storageClassApi : StorageClassApi","title":"storageClassApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#vpaapi","text":"\u2022 Const vpaApi : VerticalPodAutoscalerApi","title":"vpaApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Renderer.K8sApi/#createresourcestack","text":"\u25b8 createResourceStack ( cluster , name ): ResourceApplyingStack","title":"createResourceStack"},{"location":"extensions/api/modules/Renderer.K8sApi/#forcluster","text":"\u25b8 forCluster < Object , Api , Data >( cluster , kubeClass , apiClass ): Api","title":"forCluster"},{"location":"extensions/api/modules/Renderer.K8sApi/#forremotecluster","text":"\u25b8 forRemoteCluster < Object , Api , Data >( config , kubeClass , apiClass ): Api","title":"forRemoteCluster"},{"location":"extensions/api/modules/Renderer.K8sApi/#isallowedresource","text":"\u25b8 isAllowedResource ( resources ): boolean","title":"isAllowedResource"},{"location":"extensions/api/modules/Renderer.Navigation/","text":"Namespace: Navigation # Renderer .Navigation Table of contents # Classes # PageParam Interfaces # PageParamInit URLParams Functions # createPageParam getDetailsUrl hideDetails isActiveRoute navigate showDetails Functions # createPageParam # \u25b8 createPageParam < Value >( init ): PageParam < Value > Type parameters # Name Type Value string Parameters # Name Type init PageParamInit < Value > Returns # PageParam < Value > getDetailsUrl # \u25b8 getDetailsUrl ( selfLink , resetSelected? , mergeGlobals? ): string Parameters # Name Type selfLink string resetSelected? boolean mergeGlobals? boolean Returns # string hideDetails # \u25b8 hideDetails (): void Returns # void isActiveRoute # \u25b8 isActiveRoute ( route ): boolean Parameters # Name Type route string | string [] | RouteProps < string , {}> Returns # boolean navigate # \u25b8 navigate ( location ): void Parameters # Name Type location LocationDescriptor < unknown > Returns # void showDetails # \u25b8 showDetails ( selfLink , resetSelected? ): void Default resetSelected true Parameters # 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) Returns # void","title":"Namespace: Navigation"},{"location":"extensions/api/modules/Renderer.Navigation/#namespace-navigation","text":"Renderer .Navigation","title":"Namespace: Navigation"},{"location":"extensions/api/modules/Renderer.Navigation/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Renderer.Navigation/#classes","text":"PageParam","title":"Classes"},{"location":"extensions/api/modules/Renderer.Navigation/#interfaces","text":"PageParamInit URLParams","title":"Interfaces"},{"location":"extensions/api/modules/Renderer.Navigation/#functions","text":"createPageParam getDetailsUrl hideDetails isActiveRoute navigate showDetails","title":"Functions"},{"location":"extensions/api/modules/Renderer.Navigation/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Renderer.Navigation/#createpageparam","text":"\u25b8 createPageParam < Value >( init ): PageParam < Value >","title":"createPageParam"},{"location":"extensions/api/modules/Renderer.Navigation/#getdetailsurl","text":"\u25b8 getDetailsUrl ( selfLink , resetSelected? , mergeGlobals? ): string","title":"getDetailsUrl"},{"location":"extensions/api/modules/Renderer.Navigation/#hidedetails","text":"\u25b8 hideDetails (): void","title":"hideDetails"},{"location":"extensions/api/modules/Renderer.Navigation/#isactiveroute","text":"\u25b8 isActiveRoute ( route ): boolean","title":"isActiveRoute"},{"location":"extensions/api/modules/Renderer.Navigation/#navigate","text":"\u25b8 navigate ( location ): void","title":"navigate"},{"location":"extensions/api/modules/Renderer.Navigation/#showdetails","text":"\u25b8 showDetails ( selfLink , resetSelected? ): void Default resetSelected true","title":"showDetails"},{"location":"extensions/api/modules/Renderer.Theme/","text":"Namespace: Theme # Renderer .Theme Table of contents # Interfaces # LensTheme Variables # activeTheme Functions # getActiveTheme Variables # activeTheme # \u2022 Const activeTheme : IComputedValue Functions # getActiveTheme # \u25b8 getActiveTheme (): ReadonlyObjectDeep Deprecated This hides the reactivity of active theme, use activeTheme instead Returns # ReadonlyObjectDeep","title":"Namespace: Theme"},{"location":"extensions/api/modules/Renderer.Theme/#namespace-theme","text":"Renderer .Theme","title":"Namespace: Theme"},{"location":"extensions/api/modules/Renderer.Theme/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Renderer.Theme/#interfaces","text":"LensTheme","title":"Interfaces"},{"location":"extensions/api/modules/Renderer.Theme/#variables","text":"activeTheme","title":"Variables"},{"location":"extensions/api/modules/Renderer.Theme/#functions","text":"getActiveTheme","title":"Functions"},{"location":"extensions/api/modules/Renderer.Theme/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Renderer.Theme/#activetheme","text":"\u2022 Const activeTheme : IComputedValue","title":"activeTheme"},{"location":"extensions/api/modules/Renderer.Theme/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Renderer.Theme/#getactivetheme","text":"\u25b8 getActiveTheme (): ReadonlyObjectDeep Deprecated This hides the reactivity of active theme, use activeTheme instead","title":"getActiveTheme"},{"location":"extensions/api/modules/Renderer/","text":"Namespace: Renderer # Table of contents # Namespaces # Catalog Component K8sApi Navigation Theme Classes # Ipc LensExtension","title":"Namespace: Renderer"},{"location":"extensions/api/modules/Renderer/#namespace-renderer","text":"","title":"Namespace: Renderer"},{"location":"extensions/api/modules/Renderer/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Renderer/#namespaces","text":"Catalog Component K8sApi Navigation Theme","title":"Namespaces"},{"location":"extensions/api/modules/Renderer/#classes","text":"Ipc LensExtension","title":"Classes"},{"location":"extensions/capabilities/","text":"","title":"Index"},{"location":"extensions/capabilities/common-capabilities/","text":"Common Capabilities # 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. Main Extension # 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. Activate # This extension can register a custom callback that is executed when an extension is activated (started). import { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { async onActivate () { console . log ( \"hello world\" ) } } Deactivate # This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { async onDeactivate () { console . log ( \"bye bye\" ) } } Menus # This extension can register custom app and tray menus that will be displayed on OS native menus. Example: import { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Example item\" , click () { Main . Navigation . navigate ( \"https://k8slens.dev\" ); } } ] trayMenus = [ { label : \"My links\" , submenu : [ { label : \"Lens\" , click () { Main . Navigation . navigate ( \"https://k8slens.dev\" ); } }, { type : \"separator\" }, { label : \"Lens Github\" , click () { Main . Navigation . navigate ( \"https://github.com/lensapp/lens\" ); } } ] } ] } Renderer Extension # 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 . Activate # This extension can register a custom callback that is executed when an extension is activated (started). import { Renderer } from \"@k8slens/extensions\" export default class ExampleExtension extends Renderer . LensExtension { async onActivate () { console . log ( \"hello world\" ) } } Deactivate # This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { Renderer } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Renderer . LensExtension { async onDeactivate () { console . log ( \"bye bye\" ) } } Global Pages # 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\" import { Renderer } from \"@k8slens/extensions\" import { ExamplePage } from \"./src/example-page\" const { Component : { Icon , } } = Renderer ; export default class ExampleRendererExtension extends Renderer . LensExtension { globalPages = [ { id : \"example\" , components : { Page : ExamplePage , } } ] globalPageMenus = [ { title : \"Example page\" , // used in icon's tooltip target : { pageId : \"example\" } components : { Icon : () => < Icon material = \"arrow\" /> , } } ] } App Preferences # This extension can register custom app preferences. It is responsible for storing a state for custom preferences. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" import { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\" import { MyCustomPreferenceHint , MyCustomPreferenceInput } from \"./src/my-custom-preference\" export default class ExampleRendererExtension extends Renderer . LensExtension { appPreferences = [ { title : \"My Custom Preference\" , components : { Hint : () => < MyCustomPreferenceHint /> , Input : () => < MyCustomPreferenceInput store = { myCustomPreferencesStore } /> } } ] } Cluster Pages # This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./src/page\" export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"extension-example\" , // optional exact : true , // optional components : { Page : () => < ExamplePage extension = { this } /> , } } ] clusterPageMenus = [ { url : \"/extension-example\" , // optional title : \"Example Extension\" , components : { Icon : ExampleIcon , } } ] } Top Bar Items # This extension can register custom components to a top bar area. import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , } } = Renderer ; export default class ExampleExtension extends Renderer . LensExtension { topBarItems = [ { components : { Item : () => ( < Icon material = \"favorite\" onClick = {() => this . navigate ( \"/example-page\" /> ) } } ] } Status Bar Items # This extension can register custom icons and text to a status bar area. import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , } } = Renderer ; export default class ExampleExtension extends Renderer . LensExtension { statusBarItems = [ { components : { Item : () => ( < div className = \"flex align-center gaps hover-highlight\" onClick = {() => this . navigate ( \"/example-page\" )} > < Icon material = \"favorite\" /> < /div> ) } } ] } Kubernetes Workloads Overview Items # This extension can register custom workloads overview items. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomWorkloadsOverviewItem } from \"./src/custom-workloads-overview-item\" export default class ExampleExtension extends Renderer . LensExtension { kubeWorkloadsOverviewItems = [ { components : { Details : () => < CustomWorkloadsOverviewItem /> } } ] } Kubernetes Object Menu Items # This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomMenuItem , CustomMenuItemProps } from \"./src/custom-menu-item\" export default class ExampleExtension extends Renderer . LensExtension { kubeObjectMenuItems = [ { kind : \"Node\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : CustomMenuItemProps ) => < CustomMenuItem {... props } /> } } ] } Kubernetes Object Details # This extension can register custom details (content) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomKindDetails , CustomKindDetailsProps } from \"./src/custom-kind-details\" export default class ExampleExtension extends Renderer . LensExtension { kubeObjectDetailItems = [ { kind : \"CustomKind\" , apiVersions : [ \"custom.acme.org/v1\" ], components : { Details : ( props : CustomKindDetailsProps ) => < CustomKindDetails {... props } /> } } ] }","title":"Common Capabilities"},{"location":"extensions/capabilities/common-capabilities/#common-capabilities","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.","title":"Common Capabilities"},{"location":"extensions/capabilities/common-capabilities/#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.","title":"Main Extension"},{"location":"extensions/capabilities/common-capabilities/#activate","text":"This extension can register a custom callback that is executed when an extension is activated (started). import { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { async onActivate () { console . log ( \"hello world\" ) } }","title":"Activate"},{"location":"extensions/capabilities/common-capabilities/#deactivate","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { async onDeactivate () { console . log ( \"bye bye\" ) } }","title":"Deactivate"},{"location":"extensions/capabilities/common-capabilities/#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\" export default class ExampleMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Example item\" , click () { Main . Navigation . navigate ( \"https://k8slens.dev\" ); } } ] trayMenus = [ { label : \"My links\" , submenu : [ { label : \"Lens\" , click () { Main . Navigation . navigate ( \"https://k8slens.dev\" ); } }, { type : \"separator\" }, { label : \"Lens Github\" , click () { Main . Navigation . navigate ( \"https://github.com/lensapp/lens\" ); } } ] } ] }","title":"Menus"},{"location":"extensions/capabilities/common-capabilities/#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 .","title":"Renderer Extension"},{"location":"extensions/capabilities/common-capabilities/#activate_1","text":"This extension can register a custom callback that is executed when an extension is activated (started). import { Renderer } from \"@k8slens/extensions\" export default class ExampleExtension extends Renderer . LensExtension { async onActivate () { console . log ( \"hello world\" ) } }","title":"Activate"},{"location":"extensions/capabilities/common-capabilities/#deactivate_1","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { Renderer } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Renderer . LensExtension { async onDeactivate () { console . log ( \"bye bye\" ) } }","title":"Deactivate"},{"location":"extensions/capabilities/common-capabilities/#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\" import { Renderer } from \"@k8slens/extensions\" import { ExamplePage } from \"./src/example-page\" const { Component : { Icon , } } = Renderer ; export default class ExampleRendererExtension extends Renderer . LensExtension { globalPages = [ { id : \"example\" , components : { Page : ExamplePage , } } ] globalPageMenus = [ { title : \"Example page\" , // used in icon's tooltip target : { pageId : \"example\" } components : { Icon : () => < Icon material = \"arrow\" /> , } } ] }","title":"Global Pages"},{"location":"extensions/capabilities/common-capabilities/#app-preferences","text":"This extension can register custom app preferences. It is responsible for storing a state for custom preferences. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" import { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\" import { MyCustomPreferenceHint , MyCustomPreferenceInput } from \"./src/my-custom-preference\" export default class ExampleRendererExtension extends Renderer . LensExtension { appPreferences = [ { title : \"My Custom Preference\" , components : { Hint : () => < MyCustomPreferenceHint /> , Input : () => < MyCustomPreferenceInput store = { myCustomPreferencesStore } /> } } ] }","title":"App Preferences"},{"location":"extensions/capabilities/common-capabilities/#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\" import { Renderer } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./src/page\" export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"extension-example\" , // optional exact : true , // optional components : { Page : () => < ExamplePage extension = { this } /> , } } ] clusterPageMenus = [ { url : \"/extension-example\" , // optional title : \"Example Extension\" , components : { Icon : ExampleIcon , } } ] }","title":"Cluster Pages"},{"location":"extensions/capabilities/common-capabilities/#top-bar-items","text":"This extension can register custom components to a top bar area. import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , } } = Renderer ; export default class ExampleExtension extends Renderer . LensExtension { topBarItems = [ { components : { Item : () => ( < Icon material = \"favorite\" onClick = {() => this . navigate ( \"/example-page\" /> ) } } ] }","title":"Top Bar Items"},{"location":"extensions/capabilities/common-capabilities/#status-bar-items","text":"This extension can register custom icons and text to a status bar area. import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , } } = Renderer ; export default class ExampleExtension extends Renderer . LensExtension { statusBarItems = [ { components : { Item : () => ( < div className = \"flex align-center gaps hover-highlight\" onClick = {() => this . navigate ( \"/example-page\" )} > < Icon material = \"favorite\" /> < /div> ) } } ] }","title":"Status Bar Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-workloads-overview-items","text":"This extension can register custom workloads overview items. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomWorkloadsOverviewItem } from \"./src/custom-workloads-overview-item\" export default class ExampleExtension extends Renderer . LensExtension { kubeWorkloadsOverviewItems = [ { components : { Details : () => < CustomWorkloadsOverviewItem /> } } ] }","title":"Kubernetes Workloads Overview Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-menu-items","text":"This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomMenuItem , CustomMenuItemProps } from \"./src/custom-menu-item\" export default class ExampleExtension extends Renderer . LensExtension { kubeObjectMenuItems = [ { kind : \"Node\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : CustomMenuItemProps ) => < CustomMenuItem {... props } /> } } ] }","title":"Kubernetes Object Menu Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-details","text":"This extension can register custom details (content) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomKindDetails , CustomKindDetailsProps } from \"./src/custom-kind-details\" export default class ExampleExtension extends Renderer . LensExtension { kubeObjectDetailItems = [ { kind : \"CustomKind\" , apiVersions : [ \"custom.acme.org/v1\" ], components : { Details : ( props : CustomKindDetailsProps ) => < CustomKindDetails {... props } /> } } ] }","title":"Kubernetes Object Details"},{"location":"extensions/capabilities/styling/","text":"Styling an Extension # 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. Layout # 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 { display : flex ; flex-direction : column ; align-items : center ; } However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS. Layout Variables # 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 ; --padding : var ( --unit ); --margin : var ( --unit ); --border-radius : 3px ; These variables are intended to set consistent margins and paddings across components. For example: . status { padding-left : calc ( var ( --padding ) * 2 ); border-radius : var ( --border-radius ); } Themes # Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark. Theme Variables # 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 ; --font-monospace : Lucida Console , Monaco , Consolas , monospace ; --font-size-small : calc ( 1 . 5 * var ( --unit )); --font-size : calc ( 1 . 75 * var ( --unit )); --font-size-big : calc ( 2 * var ( --unit )); --font-weight-thin : 300 ; --font-weight-normal : 400 ; --font-weight-bold : 500 ; as well as in the theme modules : --blue: #3d90ce; --magenta: #c93dce; --golden: #ffc63d; --halfGray: #87909c80; --primary: #3d90ce; --textColorPrimary: #555555; --textColorSecondary: #51575d; --textColorAccent: #333333; --borderColor: #c9cfd3; --borderFaintColor: #dfdfdf; --mainBackground: #f1f1f1; --contentColor: #ffffff; --layoutBackground: #e8e8e8; --layoutTabsBackground: #f8f8f8; --layoutTabsActiveColor: #333333; --layoutTabsLineColor: #87909c80; ... These variables can be used in the following form: var(--magenta) . For example: . status { font-size : var ( --font-size-small ); background-color : var ( --colorSuccess ); } Theme Switching # When the light theme is active, the element gets a \"theme-light\" class, or: . 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\" import { observer } from \"mobx-react\" import { Renderer } from \"@k8slens/extensions\" ; @ observer export class SupportPage extends React . Component { render () { return ( < div className = \"SupportPage\" > < h1 > Active theme is { Renderer . Theme . getActiveTheme (). name } < /h1> < /div> ); } } 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. Injected Styles # Every extension is affected by the list of default global styles defined in app.scss . These are basic browser resets and element styles, including: setting the box-sizing property for every element default text and background colors default font sizes basic heading (h1, h2, etc) formatting custom scrollbar styling Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy. CSS-in-JS # If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows: const Container = styled . div (() => ({ backgroundColor : 'var(--mainBackground)' })); Examples # You can explore samples for each styling technique that you can use for extensions: Styling with Sass Styling with Emotion Styling with CSS Modules","title":"Styling"},{"location":"extensions/capabilities/styling/#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.","title":"Styling an Extension"},{"location":"extensions/capabilities/styling/#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 { display : flex ; flex-direction : column ; align-items : center ; } However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS.","title":"Layout"},{"location":"extensions/capabilities/styling/#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 ; --padding : var ( --unit ); --margin : var ( --unit ); --border-radius : 3px ; These variables are intended to set consistent margins and paddings across components. For example: . status { padding-left : calc ( var ( --padding ) * 2 ); border-radius : var ( --border-radius ); }","title":"Layout Variables"},{"location":"extensions/capabilities/styling/#themes","text":"Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark.","title":"Themes"},{"location":"extensions/capabilities/styling/#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 ; --font-monospace : Lucida Console , Monaco , Consolas , monospace ; --font-size-small : calc ( 1 . 5 * var ( --unit )); --font-size : calc ( 1 . 75 * var ( --unit )); --font-size-big : calc ( 2 * var ( --unit )); --font-weight-thin : 300 ; --font-weight-normal : 400 ; --font-weight-bold : 500 ; as well as in the theme modules : --blue: #3d90ce; --magenta: #c93dce; --golden: #ffc63d; --halfGray: #87909c80; --primary: #3d90ce; --textColorPrimary: #555555; --textColorSecondary: #51575d; --textColorAccent: #333333; --borderColor: #c9cfd3; --borderFaintColor: #dfdfdf; --mainBackground: #f1f1f1; --contentColor: #ffffff; --layoutBackground: #e8e8e8; --layoutTabsBackground: #f8f8f8; --layoutTabsActiveColor: #333333; --layoutTabsLineColor: #87909c80; ... These variables can be used in the following form: var(--magenta) . For example: . status { font-size : var ( --font-size-small ); background-color : var ( --colorSuccess ); }","title":"Theme Variables"},{"location":"extensions/capabilities/styling/#theme-switching","text":"When the light theme is active, the element gets a \"theme-light\" class, or: . 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\" import { observer } from \"mobx-react\" import { Renderer } from \"@k8slens/extensions\" ; @ observer export class SupportPage extends React . Component { render () { return ( < div className = \"SupportPage\" > < h1 > Active theme is { Renderer . Theme . getActiveTheme (). name } < /h1> < /div> ); } } 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.","title":"Theme Switching"},{"location":"extensions/capabilities/styling/#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: setting the box-sizing property for every element default text and background colors default font sizes basic heading (h1, h2, etc) formatting custom scrollbar styling Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy.","title":"Injected Styles"},{"location":"extensions/capabilities/styling/#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 (() => ({ backgroundColor : 'var(--mainBackground)' }));","title":"CSS-in-JS"},{"location":"extensions/capabilities/styling/#examples","text":"You can explore samples for each styling technique that you can use for extensions: Styling with Sass Styling with Emotion Styling with CSS Modules","title":"Examples"},{"location":"extensions/get-started/anatomy/","text":"Extension Anatomy # 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: Implements onActivate() and outputs a message to the console. Implements onDeactivate() and outputs a message to the console. Registers 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. Extension File Structure # . \u251c\u2500\u2500 .gitignore // Ignore build output and node_modules \u251c\u2500\u2500 Makefile // Config for build tasks that compiles the extension \u251c\u2500\u2500 README.md // Readable description of your extension's functionality \u251c\u2500\u2500 src \u2502 \u2514\u2500\u2500 page.tsx // Extension's additional source code \u251c\u2500\u2500 main.ts // Source code for extension's main entrypoint \u251c\u2500\u2500 package.json // Extension manifest and dependencies \u251c\u2500\u2500 renderer.tsx // Source code for extension's renderer entrypoint \u251c\u2500\u2500 tsconfig.json // TypeScript configuration \u251c\u2500\u2500 webpack.config.js // Webpack configuration 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. Extension Manifest # 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 @/ 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. { \"name\" : \"helloworld-sample\" , \"publisher\" : \"lens-samples\" , \"version\" : \"0.0.1\" , \"description\" : \"Lens helloworld-sample\" , \"license\" : \"MIT\" , \"homepage\" : \"https://github.com/lensapp/lens-extension-samples\" , \"engines\" : { \"node\" : \"^16.14.2\" , \"lens\" : \"5.4\" }, \"main\" : \"dist/main.js\" , \"renderer\" : \"dist/renderer.js\" , \"scripts\" : { \"build\" : \"webpack --config webpack.config.js\" , \"dev\" : \"npm run build --watch\" }, \"dependencies\" : { \"react-open-doodles\" : \"^1.0.5\" }, \"devDependencies\" : { \"@k8slens/extensions\" : \"^5.4.6\" , \"ts-loader\" : \"^8.0.4\" , \"typescript\" : \"^4.5.5\" , \"@types/react\" : \"^17.0.44\" , \"@types/node\" : \"^16.14.2\" , \"webpack\" : \"^4.44.2\" , \"webpack-cli\" : \"^3.3.11\" } } Webpack configuration # The following webpack externals are provided by Lens and must be used (when available) to make sure that the versions used are in sync. Package webpack external syntax Lens versions Available in Main Available in Renderer 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. { ... \"externals\" : [ ... { \"mobx\" : \"var global.Mobx\" \"mobx-react\" : \"var global.MobxReact\" \"react\" : \"var global.React\" \"react-router\" : \"var global.ReactRouter\" \"react-router-dom\" : \"var global.ReactRouterDom\" \"react-dom\" : \"var global.ReactDOM\" } ] } Extension Entry Files # 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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"extension-example\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; } 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.","title":"Extension Anatomy"},{"location":"extensions/get-started/anatomy/#extension-anatomy","text":"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: Implements onActivate() and outputs a message to the console. Implements onDeactivate() and outputs a message to the console. Registers 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.","title":"Extension Anatomy"},{"location":"extensions/get-started/anatomy/#extension-file-structure","text":". \u251c\u2500\u2500 .gitignore // Ignore build output and node_modules \u251c\u2500\u2500 Makefile // Config for build tasks that compiles the extension \u251c\u2500\u2500 README.md // Readable description of your extension's functionality \u251c\u2500\u2500 src \u2502 \u2514\u2500\u2500 page.tsx // Extension's additional source code \u251c\u2500\u2500 main.ts // Source code for extension's main entrypoint \u251c\u2500\u2500 package.json // Extension manifest and dependencies \u251c\u2500\u2500 renderer.tsx // Source code for extension's renderer entrypoint \u251c\u2500\u2500 tsconfig.json // TypeScript configuration \u251c\u2500\u2500 webpack.config.js // Webpack configuration 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.","title":"Extension File Structure"},{"location":"extensions/get-started/anatomy/#extension-manifest","text":"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 @/ 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. { \"name\" : \"helloworld-sample\" , \"publisher\" : \"lens-samples\" , \"version\" : \"0.0.1\" , \"description\" : \"Lens helloworld-sample\" , \"license\" : \"MIT\" , \"homepage\" : \"https://github.com/lensapp/lens-extension-samples\" , \"engines\" : { \"node\" : \"^16.14.2\" , \"lens\" : \"5.4\" }, \"main\" : \"dist/main.js\" , \"renderer\" : \"dist/renderer.js\" , \"scripts\" : { \"build\" : \"webpack --config webpack.config.js\" , \"dev\" : \"npm run build --watch\" }, \"dependencies\" : { \"react-open-doodles\" : \"^1.0.5\" }, \"devDependencies\" : { \"@k8slens/extensions\" : \"^5.4.6\" , \"ts-loader\" : \"^8.0.4\" , \"typescript\" : \"^4.5.5\" , \"@types/react\" : \"^17.0.44\" , \"@types/node\" : \"^16.14.2\" , \"webpack\" : \"^4.44.2\" , \"webpack-cli\" : \"^3.3.11\" } }","title":"Extension Manifest"},{"location":"extensions/get-started/anatomy/#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. Package webpack external syntax Lens versions Available in Main Available in Renderer 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. { ... \"externals\" : [ ... { \"mobx\" : \"var global.Mobx\" \"mobx-react\" : \"var global.MobxReact\" \"react\" : \"var global.React\" \"react-router\" : \"var global.ReactRouter\" \"react-router-dom\" : \"var global.ReactRouterDom\" \"react-dom\" : \"var global.ReactDOM\" } ] }","title":"Webpack configuration"},{"location":"extensions/get-started/anatomy/#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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"extension-example\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; } 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.","title":"Extension Entry Files"},{"location":"extensions/get-started/overview/","text":"Extension Development Overview # 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. Required: # Node.js Git Some sort of text editor \u2013 we recommend VSCode We use Webpack for compilation. All extension need to be at least compatible with a webpack system. Recommended: # 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.","title":"Overview"},{"location":"extensions/get-started/overview/#extension-development-overview","text":"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.","title":"Extension Development Overview"},{"location":"extensions/get-started/overview/#required","text":"Node.js Git Some sort of text editor \u2013 we recommend VSCode We use Webpack for compilation. All extension need to be at least compatible with a webpack system.","title":"Required:"},{"location":"extensions/get-started/overview/#recommended","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.","title":"Recommended:"},{"location":"extensions/get-started/wrapping-up/","text":"Wrapping Up # 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. Extension Capabilities # 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. Guides and Samples # 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. Testing and Publishing # In this section, you can learn: How to add integration tests to your extension How to publish your extension","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#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.","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#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.","title":"Extension Capabilities"},{"location":"extensions/get-started/wrapping-up/#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.","title":"Guides and Samples"},{"location":"extensions/get-started/wrapping-up/#testing-and-publishing","text":"In this section, you can learn: How to add integration tests to your extension How to publish your extension","title":"Testing and Publishing"},{"location":"extensions/get-started/your-first-extension/","text":"Your First Extension # 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. First Extension # 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. Install the Extension # To install the extension, clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git 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 . Linux & macOS # mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s lens-extension-samples/helloworld-sample helloworld-sample Windows # Create the directory that Lens will monitor for user-installed extensions: mkdir C: \\U sers \\< user> \\. k8slens \\e xtensions -force cd C: \\U sers \\< user> \\. k8slens \\e xtensions 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 \\h elloworld-sample Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\\\.k8slens\\extensions : Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\\\.k8slens\\extensions\\helloworld-sample' Build the Extension # To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build To run the npm commands, enter: cd /helloworld-sample npm install npm run build Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter: cd /helloworld-sample npm run dev 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. Develop the Extension # Finally, you'll make a change to the message that our Hello World sample extension displays: Navigate to /helloworld-sample . In page.tsx , change the message from HelloWorld! to Hello Lens Extensions . Rebuild the extension. If you used npm run dev , the extension will rebuild automatically. Reload the Lens window. Click on the Hello World page. The updated message will appear. Next Steps # 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.","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#your-first-extension","text":"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.","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#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.","title":"First Extension"},{"location":"extensions/get-started/your-first-extension/#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 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 .","title":"Install the Extension"},{"location":"extensions/get-started/your-first-extension/#linux-macos","text":"mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s lens-extension-samples/helloworld-sample helloworld-sample","title":"Linux & macOS"},{"location":"extensions/get-started/your-first-extension/#windows","text":"Create the directory that Lens will monitor for user-installed extensions: mkdir C: \\U sers \\< user> \\. k8slens \\e xtensions -force cd C: \\U sers \\< user> \\. k8slens \\e xtensions 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 \\h elloworld-sample Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\\\.k8slens\\extensions : Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\\\.k8slens\\extensions\\helloworld-sample'","title":"Windows"},{"location":"extensions/get-started/your-first-extension/#build-the-extension","text":"To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build To run the npm commands, enter: cd /helloworld-sample npm install npm run build Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter: cd /helloworld-sample npm run dev 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.","title":"Build the Extension"},{"location":"extensions/get-started/your-first-extension/#develop-the-extension","text":"Finally, you'll make a change to the message that our Hello World sample extension displays: Navigate to /helloworld-sample . In page.tsx , change the message from HelloWorld! to Hello Lens Extensions . Rebuild the extension. If you used npm run dev , the extension will rebuild automatically. Reload the Lens window. Click on the Hello World page. The updated message will appear.","title":"Develop the Extension"},{"location":"extensions/get-started/your-first-extension/#next-steps","text":"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.","title":"Next Steps"},{"location":"extensions/guides/","text":"Extension Guides # 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: Clearly commented source code. Instructions for running the sample extension. An image showing the sample extension's appearance and usage. A listing of the Extension API being used. An explanation of the concepts relevant to the Extension. Guides # Guide APIs Generate new extension project Main process extension Main.LensExtension Renderer process extension Renderer.LensExtension Resource stack (cluster feature) Extending KubernetesCluster) Stores Components KubeObjectListLayout Working with mobx Protocol Handlers Sending Data between main and renderer Catalog Entities and Categories Samples # Sample APIs hello-world LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-css-modules-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps custom-resource-page LensRendererExtension Renderer.K8sApi.KubeApi Renderer.K8sApi.KubeObjectStore Renderer.Component.KubeObjectListLayout Renderer.Component.KubeObjectDetailsProps Renderer.Component.IconProps","title":"Overview"},{"location":"extensions/guides/#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: Clearly commented source code. Instructions for running the sample extension. An image showing the sample extension's appearance and usage. A listing of the Extension API being used. An explanation of the concepts relevant to the Extension.","title":"Extension Guides"},{"location":"extensions/guides/#guides","text":"Guide APIs Generate new extension project Main process extension Main.LensExtension Renderer process extension Renderer.LensExtension Resource stack (cluster feature) Extending KubernetesCluster) Stores Components KubeObjectListLayout Working with mobx Protocol Handlers Sending Data between main and renderer Catalog Entities and Categories","title":"Guides"},{"location":"extensions/guides/#samples","text":"Sample APIs hello-world LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-css-modules-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps custom-resource-page LensRendererExtension Renderer.K8sApi.KubeApi Renderer.K8sApi.KubeObjectStore Renderer.Component.KubeObjectListLayout Renderer.Component.KubeObjectDetailsProps Renderer.Component.IconProps","title":"Samples"},{"location":"extensions/guides/anatomy/","text":"WIP #","title":"Anatomy"},{"location":"extensions/guides/anatomy/#wip","text":"","title":"WIP"},{"location":"extensions/guides/catalog/","text":"Catalog (WIP) # 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. Categories # 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: KubernetesClusters WebLinks General To register a category, call the Main.Catalog.catalogCategories.add() and Renderer.Catalog.catalogCategories.add() with instances of your class. Custom Category Views # 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\" ; function MyKubernetesClusterView ({ category , } : Common . Types . CustomCategoryViewProps ) { return < div > My view : { category . getId ()} < /div>; } export default class extends Renderer . LensExtension { customCategoryViews = [ { group : \"entity.k8slens.dev\" , kind : \"KubernetesCluster\" , priority : 10 , components : { View : MyKubernetesClusterView , }, }, ]; } 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. Styling Custom Views # By default, custom view blocks are styled with Flexbox . Some details comes from this. To set fixed height of a custom block, use max-height css rule. To set flexible height, use height . Otherwise, custom view will have height of it's contents. Entities # 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.","title":"Catalog"},{"location":"extensions/guides/catalog/#catalog-wip","text":"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.","title":"Catalog (WIP)"},{"location":"extensions/guides/catalog/#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: KubernetesClusters WebLinks General To register a category, call the Main.Catalog.catalogCategories.add() and Renderer.Catalog.catalogCategories.add() with instances of your class.","title":"Categories"},{"location":"extensions/guides/catalog/#custom-category-views","text":"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\" ; function MyKubernetesClusterView ({ category , } : Common . Types . CustomCategoryViewProps ) { return < div > My view : { category . getId ()} < /div>; } export default class extends Renderer . LensExtension { customCategoryViews = [ { group : \"entity.k8slens.dev\" , kind : \"KubernetesCluster\" , priority : 10 , components : { View : MyKubernetesClusterView , }, }, ]; } 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.","title":"Custom Category Views"},{"location":"extensions/guides/catalog/#entities","text":"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.","title":"Entities"},{"location":"extensions/guides/components/","text":"WIP #","title":"Components"},{"location":"extensions/guides/components/#wip","text":"","title":"WIP"},{"location":"extensions/guides/extending-kubernetes-cluster/","text":"Extending KubernetesCluster # Extension can specify it's own subclass of Common.Catalog.KubernetesCluster. Extension can also specify a new Category for it in the Catalog. Extending Common.Catalog.KubernetesCluster # import { Common } from \"@k8slens/extensions\" ; // The kind must be different from KubernetesCluster's kind export const kind = \"ManagedDevCluster\" ; export class ManagedDevCluster extends Common . Catalog . KubernetesCluster { public static readonly kind = kind ; public readonly kind = kind ; } Extending Common.Catalog.CatalogCategory # These custom Catalog entities can be added a new Category in the Catalog. import { Common } from \"@k8slens/extensions\" ; import { kind , ManagedDevCluster } from \"../entities/ManagedDevCluster\" ; class ManagedDevClusterCategory extends Common . Catalog . CatalogCategory { public readonly apiVersion = \"catalog.k8slens.dev/v1alpha1\" ; public readonly kind = \"CatalogCategory\" ; public metadata = { name : \"Managed Dev Clusters\" , icon : \"\" }; public spec : Common.Catalog.CatalogCategorySpec = { group : \"entity.k8slens.dev\" , versions : [ { name : \"v1alpha1\" , entityClass : ManagedDevCluster as any , }, ], names : { kind }, }; } export { ManagedDevClusterCategory }; export type { ManagedDevClusterCategory as ManagedDevClusterCategoryType }; The category needs to be registered in the onActivate() method both in main and renderer // in main's on onActivate Main . Catalog . catalogCategories . add ( new ManagedDevClusterCategory ()); // in renderer's on onActivate Renderer . Catalog . catalogCategories . add ( new ManagedDevClusterCategory ()); You can then add the entities to the Catalog as a new source: this . addCatalogSource ( \"managedDevClusters\" , this . managedDevClusters );","title":"Extending KubernetesCluster"},{"location":"extensions/guides/extending-kubernetes-cluster/#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.","title":"Extending KubernetesCluster"},{"location":"extensions/guides/extending-kubernetes-cluster/#extending-commoncatalogkubernetescluster","text":"import { Common } from \"@k8slens/extensions\" ; // The kind must be different from KubernetesCluster's kind export const kind = \"ManagedDevCluster\" ; export class ManagedDevCluster extends Common . Catalog . KubernetesCluster { public static readonly kind = kind ; public readonly kind = kind ; }","title":"Extending Common.Catalog.KubernetesCluster"},{"location":"extensions/guides/extending-kubernetes-cluster/#extending-commoncatalogcatalogcategory","text":"These custom Catalog entities can be added a new Category in the Catalog. import { Common } from \"@k8slens/extensions\" ; import { kind , ManagedDevCluster } from \"../entities/ManagedDevCluster\" ; class ManagedDevClusterCategory extends Common . Catalog . CatalogCategory { public readonly apiVersion = \"catalog.k8slens.dev/v1alpha1\" ; public readonly kind = \"CatalogCategory\" ; public metadata = { name : \"Managed Dev Clusters\" , icon : \"\" }; public spec : Common.Catalog.CatalogCategorySpec = { group : \"entity.k8slens.dev\" , versions : [ { name : \"v1alpha1\" , entityClass : ManagedDevCluster as any , }, ], names : { kind }, }; } export { ManagedDevClusterCategory }; export type { ManagedDevClusterCategory as ManagedDevClusterCategoryType }; The category needs to be registered in the onActivate() method both in main and renderer // in main's on onActivate Main . Catalog . catalogCategories . add ( new ManagedDevClusterCategory ()); // in renderer's on onActivate Renderer . Catalog . catalogCategories . add ( new ManagedDevClusterCategory ()); You can then add the entities to the Catalog as a new source: this . addCatalogSource ( \"managedDevClusters\" , this . managedDevClusters );","title":"Extending Common.Catalog.CatalogCategory"},{"location":"extensions/guides/generator/","text":"Lens Extension Generator # The Lens Extension Generator creates a directory with the necessary files for developing an extension. Installing and Getting Started with the Generator # To begin, install Yeoman and the Lens Extension Generator with the following command: npm install -g yo generator-lens-ext 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) # ? What's the name of your extension? my-first-lens-ext # ? What's the description of your extension? My hello world extension # ? What's your extension's publisher name? @my-org/my-first-lens-ext # ? Initialize a git repository? Yes # ? Install dependencies after initialization? Yes # ? Which package manager to use? yarn # ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :Users\\\\.k8slens\\extensions (windows)? Yes Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering: cd my-first-lens-ext npm start # start the webpack server in watch mode Open Lens and you will see a Hello World item in the left-side menu under Custom Resources : Developing the Extension # 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 = [ { target : { pageId : \"hello\" }, title : \"Hello Lens\" , components : { Icon : ExampleIcon , }, }, ]; 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. Debugging the Extension # To debug your extension, please see our instructions on Testing Extensions . Next Steps # 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 .","title":"Generator"},{"location":"extensions/guides/generator/#lens-extension-generator","text":"The Lens Extension Generator creates a directory with the necessary files for developing an extension.","title":"Lens Extension Generator"},{"location":"extensions/guides/generator/#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 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) # ? What's the name of your extension? my-first-lens-ext # ? What's the description of your extension? My hello world extension # ? What's your extension's publisher name? @my-org/my-first-lens-ext # ? Initialize a git repository? Yes # ? Install dependencies after initialization? Yes # ? Which package manager to use? yarn # ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :Users\\\\.k8slens\\extensions (windows)? Yes Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering: cd my-first-lens-ext npm start # start the webpack server in watch mode Open Lens and you will see a Hello World item in the left-side menu under Custom Resources :","title":"Installing and Getting Started with the Generator"},{"location":"extensions/guides/generator/#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 = [ { target : { pageId : \"hello\" }, title : \"Hello Lens\" , components : { Icon : ExampleIcon , }, }, ]; 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.","title":"Developing the Extension"},{"location":"extensions/guides/generator/#debugging-the-extension","text":"To debug your extension, please see our instructions on Testing Extensions .","title":"Debugging the Extension"},{"location":"extensions/guides/generator/#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 .","title":"Next Steps"},{"location":"extensions/guides/ipc/","text":"Inter Process Communication # 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. Types of Communication # There are two flavours of communication that are provided: Event based (IPC) Request based (RPC) Event Based or IPC # 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. Request Based or RPC # 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 . 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. Registering IPC Handlers and Listeners # The general terminology is as follows: A \"handler\" is the function that responds to a \"Request Based IPC\" event. A \"listener\" is the function that is called when a \"Event Based IPC\" event is emitted. To register either a handler or a listener, you should do something like the following: main.ts : import { Main } from \"@k8slens/extensions\" ; import { IpcMain } from \"./helpers/main\" ; export class ExampleExtensionMain extends Main . LensExtension { onActivate () { IpcMain . createInstance ( this ); } } 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\" ; export class IpcMain extends Main . Ipc { constructor ( extension : Main.LensExtension ) { super ( extension ); this . listen ( \"initialize\" , onInitialize ); } } function onInitialize ( event : Types.IpcMainEvent , id : string ) { console . log ( `starting to initialize: ${ id } ` ); } 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\" ; import { IpcRenderer } from \"./helpers/renderer\" ; export class ExampleExtensionRenderer extends Renderer . LensExtension { onActivate () { const ipc = IpcRenderer . createInstance ( this ); setTimeout (() => ipc . broadcast ( \"initialize\" , \"an-id\" ), 5000 ); } } It is also needed to create an instance to broadcast messages too. helpers/renderer.ts : import { Renderer } from \"@k8slens/extensions\" ; export class IpcRenderer extends Renderer . Ipc {} 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. Allowed Values # 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. Using Request Based Communication # If you are meaning to do a request based call from renderer , you should do const res = await IpcRenderer.getInstance().invoke(, ...)); instead.","title":"IPC"},{"location":"extensions/guides/ipc/#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.","title":"Inter Process Communication"},{"location":"extensions/guides/ipc/#types-of-communication","text":"There are two flavours of communication that are provided: Event based (IPC) Request based (RPC)","title":"Types of Communication"},{"location":"extensions/guides/ipc/#event-based-or-ipc","text":"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.","title":"Event Based or IPC"},{"location":"extensions/guides/ipc/#request-based-or-rpc","text":"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 . 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.","title":"Request Based or RPC"},{"location":"extensions/guides/ipc/#registering-ipc-handlers-and-listeners","text":"The general terminology is as follows: A \"handler\" is the function that responds to a \"Request Based IPC\" event. A \"listener\" is the function that is called when a \"Event Based IPC\" event is emitted. To register either a handler or a listener, you should do something like the following: main.ts : import { Main } from \"@k8slens/extensions\" ; import { IpcMain } from \"./helpers/main\" ; export class ExampleExtensionMain extends Main . LensExtension { onActivate () { IpcMain . createInstance ( this ); } } 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\" ; export class IpcMain extends Main . Ipc { constructor ( extension : Main.LensExtension ) { super ( extension ); this . listen ( \"initialize\" , onInitialize ); } } function onInitialize ( event : Types.IpcMainEvent , id : string ) { console . log ( `starting to initialize: ${ id } ` ); } 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\" ; import { IpcRenderer } from \"./helpers/renderer\" ; export class ExampleExtensionRenderer extends Renderer . LensExtension { onActivate () { const ipc = IpcRenderer . createInstance ( this ); setTimeout (() => ipc . broadcast ( \"initialize\" , \"an-id\" ), 5000 ); } } It is also needed to create an instance to broadcast messages too. helpers/renderer.ts : import { Renderer } from \"@k8slens/extensions\" ; export class IpcRenderer extends Renderer . Ipc {} 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.","title":"Registering IPC Handlers and Listeners"},{"location":"extensions/guides/ipc/#allowed-values","text":"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.","title":"Allowed Values"},{"location":"extensions/guides/ipc/#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(, ...)); instead.","title":"Using Request Based Communication"},{"location":"extensions/guides/kube-object-list-layout/","text":"KubeObjectListLayout Sample # 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: Register ClusterPage and ClusterPageMenu objects List Certificate Objects on the Cluster Page Customize Details Panel Register clusterPage and clusterPageMenu Objects # 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 { } 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\" ; type IconProps = Renderer . Component . IconProps ; const { Component : { Icon , }, } = Renderer ; export function CertificateIcon ( props : IconProps ) { return < Icon {... props } material = \"security\" tooltip = \"Certificates\" /> } export default class CrdSampleExtension extends Renderer . LensExtension { clusterPageMenus = [ { target : { pageId : \"certificates\" }, title : \"Certificates\" , components : { Icon : CertificateIcon , } }, ] } Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates. export default class CrdSampleExtension extends Renderer . LensExtension { ... clusterPages = [{ id : \"certificates\" , components : { Page : () => < CertificatePage extension = { this } /> , MenuIcon : CertificateIcon , } }] } List Certificate Objects on the Cluster Page # 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. Get 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 , CertificatesApi derived 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\" ; const { K8sApi : { KubeObject , KubeObjectStore , KubeApi , apiManager , }, } = Renderer ; export class Certificate extends KubeObject { static kind = \"Certificate\" static namespaced = true static apiBase = \"/apis/cert-manager.io/v1alpha2/certificates\" kind : string apiVersion : string metadata : { name : string ; namespace : string ; selfLink : string ; uid : string ; resourceVersion : string ; creationTimestamp : string ; labels : { [ key : string ] : string ; }; annotations : { [ key : string ] : string ; }; } spec : { dnsNames : string []; issuerRef : { group : string ; kind : string ; name : string ; } secretName : string } status : { conditions : { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type ? : string ; }[]; } } With CertificatesApi class we are able to manage Certificate objects in Kubernetes API: export class CertificatesApi extends KubeApi < Certificate > {} export const certificatesApi = new CertificatesApi ({ objectConstructor : Certificate }); CertificateStore defines storage for Certificate objects export class CertificatesStore extends KubeObjectStore < Certificate > { api = certificatesApi } export const certificatesStore = new CertificatesStore (); And, finally, we register this store to Lens's API manager. apiManager . registerStore ( certificatesStore ); Create CertificatePage component # 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\" ; import React from \"react\" ; import { certificatesStore } from \"../certificate-store\" ; import { Certificate } from \"../certificate\" export class CertificatePage extends React . Component < { extension : Renderer.LensExtension } > { } 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\" ; const { Component : { TabLayout , KubeObjectListLayout , }, } = Renderer ; enum sortBy { name = \"name\" , namespace = \"namespace\" , issuer = \"issuer\" } export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { // ... render () { return ( < TabLayout > < KubeObjectListLayout className = \"Certificates\" store = { certificatesStore } sortingCallbacks = {{ [ sortBy . name ] : ( certificate : Certificate ) => certificate . getName (), [ sortBy . namespace ] : ( certificate : Certificate ) => certificate . metadata . namespace , [ sortBy . issuer ] : ( certificate : Certificate ) => certificate . spec . issuerRef . name }} searchFilters = {[ ( certificate : Certificate ) => certificate . getSearchFields () ]} renderHeaderTitle = \"Certificates\" renderTableHeader = {[ { title : \"Name\" , className : \"name\" , sortBy : sortBy.name }, { title : \"Namespace\" , className : \"namespace\" , sortBy : sortBy.namespace }, { title : \"Issuer\" , className : \"issuer\" , sortBy : sortBy.namespace }, ]} renderTableContents = {( certificate : Certificate ) => [ certificate . getName (), certificate . metadata . namespace , certificate . spec . issuerRef . name ]} /> < /TabLayout> ) } } Customize Details panel # 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 { //... kubeObjectDetailItems = [{ kind : Certificate.kind , apiVersions : [ \"cert-manager.io/v1alpha2\" ], components : { Details : ( props : CertificateDetailsProps ) => < CertificateDetails {... props } /> } }] } 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\" ; import React from \"react\" ; import { Certificate } from \"../certificate\" ; const { Component : { KubeObjectDetailsProps , DrawerItem , Badge , } } = Renderer ; export interface CertificateDetailsProps extends KubeObjectDetailsProps < Certificate > { } export class CertificateDetails extends React . Component < CertificateDetailsProps > { render () { const { object : certificate } = this . props ; if ( ! certificate ) return null ; return ( < div className = \"Certificate\" > < DrawerItem name = \"Created\" > { certificate . getAge ( true , false )} ago ({ certificate . metadata . creationTimestamp }) < /DrawerItem> < DrawerItem name = \"DNS Names\" > { certificate . spec . dnsNames . join ( \",\" )} < /DrawerItem> < DrawerItem name = \"Secret\" > { certificate . spec . secretName } < /DrawerItem> < DrawerItem name = \"Status\" className = \"status\" labelsOnly > { certificate . status . conditions . map (( condition , index ) => { const { type , reason , message , status } = condition ; const kind = type || reason ; if ( ! kind ) return null ; return ( < Badge key = { kind + index } label = { kind } className = { \"success \" + kind . toLowerCase ()} tooltip = { message } /> ); })} < /DrawerItem> < /div> ) } } Summary # 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.","title":"KubeObjectListLayout Sample"},{"location":"extensions/guides/kube-object-list-layout/#kubeobjectlistlayout-sample","text":"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: Register ClusterPage and ClusterPageMenu objects List Certificate Objects on the Cluster Page Customize Details Panel","title":"KubeObjectListLayout Sample"},{"location":"extensions/guides/kube-object-list-layout/#register-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 { } 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\" ; type IconProps = Renderer . Component . IconProps ; const { Component : { Icon , }, } = Renderer ; export function CertificateIcon ( props : IconProps ) { return < Icon {... props } material = \"security\" tooltip = \"Certificates\" /> } export default class CrdSampleExtension extends Renderer . LensExtension { clusterPageMenus = [ { target : { pageId : \"certificates\" }, title : \"Certificates\" , components : { Icon : CertificateIcon , } }, ] } Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates. export default class CrdSampleExtension extends Renderer . LensExtension { ... clusterPages = [{ id : \"certificates\" , components : { Page : () => < CertificatePage extension = { this } /> , MenuIcon : CertificateIcon , } }] }","title":"Register clusterPage and clusterPageMenu Objects"},{"location":"extensions/guides/kube-object-list-layout/#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.","title":"List Certificate Objects on the Cluster Page"},{"location":"extensions/guides/kube-object-list-layout/#get-crd-objects","text":"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 , CertificatesApi derived 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\" ; const { K8sApi : { KubeObject , KubeObjectStore , KubeApi , apiManager , }, } = Renderer ; export class Certificate extends KubeObject { static kind = \"Certificate\" static namespaced = true static apiBase = \"/apis/cert-manager.io/v1alpha2/certificates\" kind : string apiVersion : string metadata : { name : string ; namespace : string ; selfLink : string ; uid : string ; resourceVersion : string ; creationTimestamp : string ; labels : { [ key : string ] : string ; }; annotations : { [ key : string ] : string ; }; } spec : { dnsNames : string []; issuerRef : { group : string ; kind : string ; name : string ; } secretName : string } status : { conditions : { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type ? : string ; }[]; } } With CertificatesApi class we are able to manage Certificate objects in Kubernetes API: export class CertificatesApi extends KubeApi < Certificate > {} export const certificatesApi = new CertificatesApi ({ objectConstructor : Certificate }); CertificateStore defines storage for Certificate objects export class CertificatesStore extends KubeObjectStore < Certificate > { api = certificatesApi } export const certificatesStore = new CertificatesStore (); And, finally, we register this store to Lens's API manager. apiManager . registerStore ( certificatesStore );","title":"Get CRD objects"},{"location":"extensions/guides/kube-object-list-layout/#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\" ; import React from \"react\" ; import { certificatesStore } from \"../certificate-store\" ; import { Certificate } from \"../certificate\" export class CertificatePage extends React . Component < { extension : Renderer.LensExtension } > { } 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\" ; const { Component : { TabLayout , KubeObjectListLayout , }, } = Renderer ; enum sortBy { name = \"name\" , namespace = \"namespace\" , issuer = \"issuer\" } export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { // ... render () { return ( < TabLayout > < KubeObjectListLayout className = \"Certificates\" store = { certificatesStore } sortingCallbacks = {{ [ sortBy . name ] : ( certificate : Certificate ) => certificate . getName (), [ sortBy . namespace ] : ( certificate : Certificate ) => certificate . metadata . namespace , [ sortBy . issuer ] : ( certificate : Certificate ) => certificate . spec . issuerRef . name }} searchFilters = {[ ( certificate : Certificate ) => certificate . getSearchFields () ]} renderHeaderTitle = \"Certificates\" renderTableHeader = {[ { title : \"Name\" , className : \"name\" , sortBy : sortBy.name }, { title : \"Namespace\" , className : \"namespace\" , sortBy : sortBy.namespace }, { title : \"Issuer\" , className : \"issuer\" , sortBy : sortBy.namespace }, ]} renderTableContents = {( certificate : Certificate ) => [ certificate . getName (), certificate . metadata . namespace , certificate . spec . issuerRef . name ]} /> < /TabLayout> ) } }","title":"Create CertificatePage component"},{"location":"extensions/guides/kube-object-list-layout/#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 { //... kubeObjectDetailItems = [{ kind : Certificate.kind , apiVersions : [ \"cert-manager.io/v1alpha2\" ], components : { Details : ( props : CertificateDetailsProps ) => < CertificateDetails {... props } /> } }] } 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\" ; import React from \"react\" ; import { Certificate } from \"../certificate\" ; const { Component : { KubeObjectDetailsProps , DrawerItem , Badge , } } = Renderer ; export interface CertificateDetailsProps extends KubeObjectDetailsProps < Certificate > { } export class CertificateDetails extends React . Component < CertificateDetailsProps > { render () { const { object : certificate } = this . props ; if ( ! certificate ) return null ; return ( < div className = \"Certificate\" > < DrawerItem name = \"Created\" > { certificate . getAge ( true , false )} ago ({ certificate . metadata . creationTimestamp }) < /DrawerItem> < DrawerItem name = \"DNS Names\" > { certificate . spec . dnsNames . join ( \",\" )} < /DrawerItem> < DrawerItem name = \"Secret\" > { certificate . spec . secretName } < /DrawerItem> < DrawerItem name = \"Status\" className = \"status\" labelsOnly > { certificate . status . conditions . map (( condition , index ) => { const { type , reason , message , status } = condition ; const kind = type || reason ; if ( ! kind ) return null ; return ( < Badge key = { kind + index } label = { kind } className = { \"success \" + kind . toLowerCase ()} tooltip = { message } /> ); })} < /DrawerItem> < /div> ) } }","title":"Customize Details panel"},{"location":"extensions/guides/kube-object-list-layout/#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.","title":"Summary"},{"location":"extensions/guides/main-extension/","text":"Main Extension # 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. Main.LensExtension Class # onActivate() and onDeactivate() Methods # To create a main extension simply extend the Main.LensExtension class: import { Main } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends Main . LensExtension { onActivate () { console . log ( \"custom main process extension code started\" ); } onDeactivate () { console . log ( \"custom main process extension de-activated\" ); } } 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: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. 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. appMenus # 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\" ; export default class SamplePageMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click () { console . log ( \"Sample clicked\" ); }, }, ]; } 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\" ; export default class SamplePageMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click : () => this . navigate ( \"myGlobalPage\" ), }, ]; } 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 # 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 { label? : string ; click ?: ( menuItem : TrayMenuRegistration ) => void ; id? : string ; type ?: \"normal\" | \"separator\" | \"submenu\" ; toolTip? : string ; enabled? : boolean ; submenu? : TrayMenuRegistration []; } The following example demonstrates how tray menus can be added from extension: import { Main } from \"@k8slens/extensions\" ; export default class SampleTrayMenuMainExtension extends Main . LensExtension { trayMenus = [ { label : \"menu from the extension\" , click : () => { console . log ( \"tray menu clicked!\" ); }, }, ]; } addCatalogSource() and removeCatalogSource() Methods # 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.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#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.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#mainlensextension-class","text":"","title":"Main.LensExtension Class"},{"location":"extensions/guides/main-extension/#onactivate-and-ondeactivate-methods","text":"To create a main extension simply extend the Main.LensExtension class: import { Main } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends Main . LensExtension { onActivate () { console . log ( \"custom main process extension code started\" ); } onDeactivate () { console . log ( \"custom main process extension de-activated\" ); } } 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: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. 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.","title":"onActivate() and onDeactivate() Methods"},{"location":"extensions/guides/main-extension/#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\" ; export default class SamplePageMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click () { console . log ( \"Sample clicked\" ); }, }, ]; } 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\" ; export default class SamplePageMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click : () => this . navigate ( \"myGlobalPage\" ), }, ]; } 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 ).","title":"appMenus"},{"location":"extensions/guides/main-extension/#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 { label? : string ; click ?: ( menuItem : TrayMenuRegistration ) => void ; id? : string ; type ?: \"normal\" | \"separator\" | \"submenu\" ; toolTip? : string ; enabled? : boolean ; submenu? : TrayMenuRegistration []; } The following example demonstrates how tray menus can be added from extension: import { Main } from \"@k8slens/extensions\" ; export default class SampleTrayMenuMainExtension extends Main . LensExtension { trayMenus = [ { label : \"menu from the extension\" , click : () => { console . log ( \"tray menu clicked!\" ); }, }, ]; }","title":"trayMenus"},{"location":"extensions/guides/main-extension/#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.","title":"addCatalogSource() and removeCatalogSource() Methods"},{"location":"extensions/guides/protocol-handlers/","text":"Lens Protocol Handlers # 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. Registering A Protocol Handler # 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\" ; function rootHandler ( params : Common.Types.ProtocolRouteParams ) { console . log ( \"routed to ExampleExtension\" , params ); } export default class ExampleExtensionMain extends Main . LensExtension { protocolHandlers = [ pathSchema : \"/\" , handler : rootHandler , ] } 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/ Deregistering A Protocol Handler # All that is needed to deregister a handler is to remove it from the array of handlers. Routing Algorithm # 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): { \"search\" : { \"text\" : \"Hello\" }, \"pathname\" : { \"type\" : \"notification\" } } 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.","title":"Protocol Handlers"},{"location":"extensions/guides/protocol-handlers/#lens-protocol-handlers","text":"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.","title":"Lens Protocol Handlers"},{"location":"extensions/guides/protocol-handlers/#registering-a-protocol-handler","text":"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\" ; function rootHandler ( params : Common.Types.ProtocolRouteParams ) { console . log ( \"routed to ExampleExtension\" , params ); } export default class ExampleExtensionMain extends Main . LensExtension { protocolHandlers = [ pathSchema : \"/\" , handler : rootHandler , ] } 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/","title":"Registering A Protocol Handler"},{"location":"extensions/guides/protocol-handlers/#deregistering-a-protocol-handler","text":"All that is needed to deregister a handler is to remove it from the array of handlers.","title":"Deregistering A Protocol Handler"},{"location":"extensions/guides/protocol-handlers/#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): { \"search\" : { \"text\" : \"Hello\" }, \"pathname\" : { \"type\" : \"notification\" } } 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.","title":"Routing Algorithm"},{"location":"extensions/guides/renderer-extension/","text":"Renderer Extension (WIP) # 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: Cluster pages Cluster page menus Global pages Welcome menus App preferences Top bar items Status bar items KubeObject menu items KubeObject detail items KubeObject status texts Kube workloads overview items as well as catalog-related UI elements: Entity settings Catalog entity detail items All UI elements are based on React components. Finally, you can also add commands and protocol handlers: Command palette commands protocol handlers Renderer.LensExtension Class # onActivate() and onDeactivate() Methods # To create a renderer extension, extend the Renderer.LensExtension class: import { Renderer } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends Renderer . LensExtension { onActivate () { console . log ( \"custom renderer process extension code started\" ); } onDeactivate () { console . log ( \"custom renderer process extension de-activated\" ); } } 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. (On Mac, it is **Lens** > **Extensions**.) 2. For the extension you want to disable, open the context menu (click on the three vertical dots) and choose **Disable**. The example above logs messages when the extension is enabled and disabled. clusterPages # 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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; } 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 . 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\" ; import React from \"react\" ; export class ExamplePage extends React . Component < { extension : LensRendererExtension ; } > { render () { return ( < div > < p > Hello world !< /p> < /div> ); } } 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 # 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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , }, }, ]; } 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\" ; import React from \"react\" ; type IconProps = Renderer . Component . IconProps ; const { Component : { Icon }, } = Renderer ; export function ExampleIcon ( props : IconProps ) { return < Icon {... props } material = \"pages\" tooltip = { \"Hi!\" } /> ; } export class ExamplePage extends React . Component < { extension : Renderer.LensExtension ; } > { render () { return ( < div > < p > Hello world !< /p> < /div> ); } } 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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, { id : \"bonjour\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; clusterPageMenus = [ { id : \"example\" , title : \"Greetings\" , components : { Icon : ExampleIcon , }, }, { parentId : \"example\" , target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , }, }, { parentId : \"example\" , target : { pageId : \"bonjour\" }, title : \"Bonjour le monde\" , components : { Icon : ExampleIcon , }, }, ]; } 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: globalPages # 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\" ; import { HelpPage } from \"./page\" ; import React from \"react\" ; export default class HelpExtension extends Renderer . LensExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , }, }, ]; } 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 . 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\" ; import React from \"react\" ; export class HelpPage extends React . Component < { extension : LensRendererExtension ; } > { render () { return ( < div > < p > Help yourself < /p> < /div> ); } } 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: To add global pages to the top menu bar, see appMenus in the Main Extension guide. To add global pages as an interactive element in the blue status bar along the bottom of the Lens UI, see statusBarItems . To add global pages to the Welcome Page, see welcomeMenus . welcomeMenus # appPreferences # 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\" ; import { ExamplePreferenceHint , ExamplePreferenceInput , } from \"./src/example-preference\" ; import { observable } from \"mobx\" ; import React from \"react\" ; export default class ExampleRendererExtension extends Renderer . LensExtension { @observable preference = { enabled : false }; appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { this . preference } /> , Hint : () => < ExamplePreferenceHint /> , }, }, ]; } 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\" ; import { makeObservable } from \"mobx\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; const { Component : { Checkbox }, } = Renderer ; export class ExamplePreferenceProps { preference : { enabled : boolean ; }; } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { public constructor () { super ({ preference : { enabled : false } }); makeObservable ( this ); } render () { const { preference } = this . props ; return ( < Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = {( v ) => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render () { return < span > This is an example of an appPreference for extensions . < /span>; } } 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 # statusBarItems # 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\" ; import { HelpIcon , HelpPage } from \"./page\" ; import React from \"react\" ; export default class HelpExtension extends Renderer . LensExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , }, }, ]; statusBarItems = [ { components : { Item : () => ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ), }, }, ]; } 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 # 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\" ; import { Renderer } from \"@k8slens/extensions\" ; import { NamespaceMenuItem } from \"./src/namespace-menu-item\" ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; export default class ExampleExtension extends Renderer . LensExtension { kubeObjectMenuItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : KubeObjectMenuProps < Namespace > ) => ( < NamespaceMenuItem {... props } /> ), }, }, ]; } 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\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { terminalStore , MenuItem , Icon }, Navigation , } = Renderer ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; export function NamespaceMenuItem ( props : KubeObjectMenuProps < Namespace > ) { const { object : namespace , toolbar } = props ; if ( ! namespace ) return null ; const namespaceName = namespace . getName (); const sendToTerminal = ( command : string ) => { terminalStore . sendCommand ( command , { enter : true , newTab : true , }); Navigation . hideDetails (); }; const getPods = () => { sendToTerminal ( `kubectl get pods -n ${ namespaceName } ` ); }; return ( < MenuItem onClick = { getPods } > < Icon material = \"speaker_group\" interactive = { toolbar } title = \"Get pods in terminal\" /> < span className = \"title\" > Get Pods < /span> < /MenuItem> ); } 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 # 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\" ; import { Renderer } from \"@k8slens/extensions\" ; import { NamespaceDetailsItem } from \"./src/namespace-details-item\" ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type KubeObjectDetailsProps = Renderer . Component . KubeObjectDetailsProps ; type Namespace = Renderer . K8sApi . Namespace ; export default class ExampleExtension extends Renderer . LensExtension { kubeObjectDetailItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], priority : 10 , components : { Details : ( props : KubeObjectDetailsProps < Namespace > ) => ( < NamespaceDetailsItem {... props } /> ), }, }, ]; } 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\" ; import { PodsDetailsList } from \"./pods-details-list\" ; import React from \"react\" ; import { observable } from \"mobx\" ; import { observer } from \"mobx-react\" ; const { K8sApi : { podsApi }, Component : { DrawerTitle }, } = Renderer ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; type Pod = Renderer . K8sApi . Pod ; @observer export class NamespaceDetailsItem extends React . Component < KubeObjectDetailsProps < Namespace > > { @observable private pods : Pod []; async componentDidMount () { const namespace = this . props . object . getName (); this . pods = await podsApi . list ({ namespace }); } render () { return ( < div > < DrawerTitle > Pods < /DrawerTitle> < PodsDetailsList pods = { this . pods } /> < /div> ); } } Since NamespaceDetailsItem extends React.Component> , 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 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\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { TableHead , TableRow , TableCell , Table }, } = Renderer ; type Pod = Renderer . K8sApi . Pod ; interface PodsDetailsListProps { pods? : Pod []; } export class PodsDetailsList extends React . Component < PodsDetailsListProps > { getTableRow = ( pod : Pod ) => { return ( < TableRow key = { index } nowrap > < TableCell className = \"podName\" > { pods [ index ]. getName ()} < /TableCell> < TableCell className = \"podAge\" > { pods [ index ]. getAge ()} < /TableCell> < TableCell className = \"podStatus\" > { pods [ index ]. getStatus ()} < /TableCell> < /TableRow> ); }; render () { const { pods } = this . props ; if ( ! pods ? . length ) { return null ; } return ( < div > < Table > < TableHead > < TableCell className = \"podName\" > Name < /TableCell> < TableCell className = \"podAge\" > Age < /TableCell> < TableCell className = \"podStatus\" > Status < /TableCell> < /TableHead> { pods . map ( this . getTableRow )} < /Table> < /div> ); } } 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 # kubeWorkloadsOverviewItems # entitySettings # catalogEntityDetailItems # commandPaletteCommands # protocolHandlers # See the Protocol Handlers Guide","title":"Renderer Extension"},{"location":"extensions/guides/renderer-extension/#renderer-extension-wip","text":"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: Cluster pages Cluster page menus Global pages Welcome menus App preferences Top bar items Status bar items KubeObject menu items KubeObject detail items KubeObject status texts Kube workloads overview items as well as catalog-related UI elements: Entity settings Catalog entity detail items All UI elements are based on React components. Finally, you can also add commands and protocol handlers: Command palette commands protocol handlers","title":"Renderer Extension (WIP)"},{"location":"extensions/guides/renderer-extension/#rendererlensextension-class","text":"","title":"Renderer.LensExtension Class"},{"location":"extensions/guides/renderer-extension/#onactivate-and-ondeactivate-methods","text":"To create a renderer extension, extend the Renderer.LensExtension class: import { Renderer } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends Renderer . LensExtension { onActivate () { console . log ( \"custom renderer process extension code started\" ); } onDeactivate () { console . log ( \"custom renderer process extension de-activated\" ); } } 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. (On Mac, it is **Lens** > **Extensions**.) 2. For the extension you want to disable, open the context menu (click on the three vertical dots) and choose **Disable**. The example above logs messages when the extension is enabled and disabled.","title":"onActivate() and onDeactivate() Methods"},{"location":"extensions/guides/renderer-extension/#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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; } 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 . 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\" ; import React from \"react\" ; export class ExamplePage extends React . Component < { extension : LensRendererExtension ; } > { render () { return ( < div > < p > Hello world !< /p> < /div> ); } } 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.","title":"clusterPages"},{"location":"extensions/guides/renderer-extension/#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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , }, }, ]; } 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\" ; import React from \"react\" ; type IconProps = Renderer . Component . IconProps ; const { Component : { Icon }, } = Renderer ; export function ExampleIcon ( props : IconProps ) { return < Icon {... props } material = \"pages\" tooltip = { \"Hi!\" } /> ; } export class ExamplePage extends React . Component < { extension : Renderer.LensExtension ; } > { render () { return ( < div > < p > Hello world !< /p> < /div> ); } } 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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, { id : \"bonjour\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; clusterPageMenus = [ { id : \"example\" , title : \"Greetings\" , components : { Icon : ExampleIcon , }, }, { parentId : \"example\" , target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , }, }, { parentId : \"example\" , target : { pageId : \"bonjour\" }, title : \"Bonjour le monde\" , components : { Icon : ExampleIcon , }, }, ]; } 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:","title":"clusterPageMenus"},{"location":"extensions/guides/renderer-extension/#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\" ; import { HelpPage } from \"./page\" ; import React from \"react\" ; export default class HelpExtension extends Renderer . LensExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , }, }, ]; } 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 . 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\" ; import React from \"react\" ; export class HelpPage extends React . Component < { extension : LensRendererExtension ; } > { render () { return ( < div > < p > Help yourself < /p> < /div> ); } } 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: To add global pages to the top menu bar, see appMenus in the Main Extension guide. To add global pages as an interactive element in the blue status bar along the bottom of the Lens UI, see statusBarItems . To add global pages to the Welcome Page, see welcomeMenus .","title":"globalPages"},{"location":"extensions/guides/renderer-extension/#welcomemenus","text":"","title":"welcomeMenus"},{"location":"extensions/guides/renderer-extension/#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\" ; import { ExamplePreferenceHint , ExamplePreferenceInput , } from \"./src/example-preference\" ; import { observable } from \"mobx\" ; import React from \"react\" ; export default class ExampleRendererExtension extends Renderer . LensExtension { @observable preference = { enabled : false }; appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { this . preference } /> , Hint : () => < ExamplePreferenceHint /> , }, }, ]; } 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\" ; import { makeObservable } from \"mobx\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; const { Component : { Checkbox }, } = Renderer ; export class ExamplePreferenceProps { preference : { enabled : boolean ; }; } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { public constructor () { super ({ preference : { enabled : false } }); makeObservable ( this ); } render () { const { preference } = this . props ; return ( < Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = {( v ) => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render () { return < span > This is an example of an appPreference for extensions . < /span>; } } 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 .","title":"appPreferences"},{"location":"extensions/guides/renderer-extension/#topbaritems","text":"","title":"topBarItems"},{"location":"extensions/guides/renderer-extension/#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\" ; import { HelpIcon , HelpPage } from \"./page\" ; import React from \"react\" ; export default class HelpExtension extends Renderer . LensExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , }, }, ]; statusBarItems = [ { components : { Item : () => ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ), }, }, ]; } 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.","title":"statusBarItems"},{"location":"extensions/guides/renderer-extension/#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\" ; import { Renderer } from \"@k8slens/extensions\" ; import { NamespaceMenuItem } from \"./src/namespace-menu-item\" ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; export default class ExampleExtension extends Renderer . LensExtension { kubeObjectMenuItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : KubeObjectMenuProps < Namespace > ) => ( < NamespaceMenuItem {... props } /> ), }, }, ]; } 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\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { terminalStore , MenuItem , Icon }, Navigation , } = Renderer ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; export function NamespaceMenuItem ( props : KubeObjectMenuProps < Namespace > ) { const { object : namespace , toolbar } = props ; if ( ! namespace ) return null ; const namespaceName = namespace . getName (); const sendToTerminal = ( command : string ) => { terminalStore . sendCommand ( command , { enter : true , newTab : true , }); Navigation . hideDetails (); }; const getPods = () => { sendToTerminal ( `kubectl get pods -n ${ namespaceName } ` ); }; return ( < MenuItem onClick = { getPods } > < Icon material = \"speaker_group\" interactive = { toolbar } title = \"Get pods in terminal\" /> < span className = \"title\" > Get Pods < /span> < /MenuItem> ); } 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.","title":"kubeObjectMenuItems"},{"location":"extensions/guides/renderer-extension/#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\" ; import { Renderer } from \"@k8slens/extensions\" ; import { NamespaceDetailsItem } from \"./src/namespace-details-item\" ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type KubeObjectDetailsProps = Renderer . Component . KubeObjectDetailsProps ; type Namespace = Renderer . K8sApi . Namespace ; export default class ExampleExtension extends Renderer . LensExtension { kubeObjectDetailItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], priority : 10 , components : { Details : ( props : KubeObjectDetailsProps < Namespace > ) => ( < NamespaceDetailsItem {... props } /> ), }, }, ]; } 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\" ; import { PodsDetailsList } from \"./pods-details-list\" ; import React from \"react\" ; import { observable } from \"mobx\" ; import { observer } from \"mobx-react\" ; const { K8sApi : { podsApi }, Component : { DrawerTitle }, } = Renderer ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; type Pod = Renderer . K8sApi . Pod ; @observer export class NamespaceDetailsItem extends React . Component < KubeObjectDetailsProps < Namespace > > { @observable private pods : Pod []; async componentDidMount () { const namespace = this . props . object . getName (); this . pods = await podsApi . list ({ namespace }); } render () { return ( < div > < DrawerTitle > Pods < /DrawerTitle> < PodsDetailsList pods = { this . pods } /> < /div> ); } } Since NamespaceDetailsItem extends React.Component> , 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 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\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { TableHead , TableRow , TableCell , Table }, } = Renderer ; type Pod = Renderer . K8sApi . Pod ; interface PodsDetailsListProps { pods? : Pod []; } export class PodsDetailsList extends React . Component < PodsDetailsListProps > { getTableRow = ( pod : Pod ) => { return ( < TableRow key = { index } nowrap > < TableCell className = \"podName\" > { pods [ index ]. getName ()} < /TableCell> < TableCell className = \"podAge\" > { pods [ index ]. getAge ()} < /TableCell> < TableCell className = \"podStatus\" > { pods [ index ]. getStatus ()} < /TableCell> < /TableRow> ); }; render () { const { pods } = this . props ; if ( ! pods ? . length ) { return null ; } return ( < div > < Table > < TableHead > < TableCell className = \"podName\" > Name < /TableCell> < TableCell className = \"podAge\" > Age < /TableCell> < TableCell className = \"podStatus\" > Status < /TableCell> < /TableHead> { pods . map ( this . getTableRow )} < /Table> < /div> ); } } 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.","title":"kubeObjectDetailItems"},{"location":"extensions/guides/renderer-extension/#kubeobjectstatustexts","text":"","title":"kubeObjectStatusTexts"},{"location":"extensions/guides/renderer-extension/#kubeworkloadsoverviewitems","text":"","title":"kubeWorkloadsOverviewItems"},{"location":"extensions/guides/renderer-extension/#entitysettings","text":"","title":"entitySettings"},{"location":"extensions/guides/renderer-extension/#catalogentitydetailitems","text":"","title":"catalogEntityDetailItems"},{"location":"extensions/guides/renderer-extension/#commandpalettecommands","text":"","title":"commandPaletteCommands"},{"location":"extensions/guides/renderer-extension/#protocolhandlers","text":"See the Protocol Handlers Guide","title":"protocolHandlers"},{"location":"extensions/guides/resource-stack/","text":"Resource Stack (Cluster Feature) # 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 kind : Pod metadata : name : example-pod spec : containers : - name : example-pod image : nginx 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\" ; import * as path from \"path\" ; const { K8sApi : { ResourceStack , forCluster , Pod , } } = Renderer ; type ResourceStack = Renderer . K8sApi . ResourceStack ; type Pod = Renderer . K8sApi . Pod ; type KubernetesCluster = Common . Catalog . KubernetesCluster ; export class ExampleClusterFeature { protected stack : ResourceStack ; constructor ( protected cluster : KubernetesCluster ) { this . stack = new ResourceStack ( cluster , \"example-resource-stack\" ); } get resourceFolder () { return path . join ( __dirname , \"../resources/\" ); } install () : Promise < string > { console . log ( \"installing example-pod\" ); return this . stack . kubectlApplyFolder ( this . resourceFolder ); } async isInstalled () : Promise < boolean > { try { const podApi = forCluster ( this . cluster , Pod ); const examplePod = await podApi . get ({ name : \"example-pod\" , namespace : \"default\" }); if ( examplePod ? . kind ) { console . log ( \"found example-pod\" ); return true ; } } catch ( e ) { console . log ( \"Error getting example-pod:\" , e ); } console . log ( \"didn't find example-pod\" ); return false ; } async uninstall () : Promise < string > { console . log ( \"uninstalling example-pod\" ); return this . stack . kubectlDeleteFolder ( this . resourceFolder ); } } 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\" ; import { Common , Renderer } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import { computed , observable , makeObservable } from \"mobx\" ; import { ExampleClusterFeature } from \"./example-cluster-feature\" ; const { Component : { SubTitle , Button , } } = Renderer ; interface ExampleClusterFeatureSettingsProps { cluster : Common.Catalog.KubernetesCluster ; } @observer export class ExampleClusterFeatureSettings extends React . Component < ExampleClusterFeatureSettingsProps > { constructor ( props : ExampleClusterFeatureSettingsProps ) { super ( props ); makeObservable ( this ); } @observable installed = false ; @observable inProgress = false ; feature : ExampleClusterFeature ; async componentDidMount () { this . feature = new ExampleClusterFeature ( this . props . cluster ); await this . updateFeatureState (); } async updateFeatureState () { this . installed = await this . feature . isInstalled (); } async save () { this . inProgress = true ; try { if ( this . installed ) { await this . feature . uninstall (); } else { await this . feature . install (); } } finally { this . inProgress = false ; await this . updateFeatureState (); } } @computed get buttonLabel () { if ( this . inProgress && this . installed ) return \"Uninstalling ...\" ; if ( this . inProgress ) return \"Applying ...\" ; if ( this . installed ) { return \"Uninstall\" ; } return \"Apply\" ; } render () { return ( <> < section > < SubTitle title = \"Example Cluster Feature using a Resource Stack\" /> < Button label = { this . buttonLabel } waiting = { this . inProgress } onClick = {() => this . save ()} primary /> < /section> < /> ); } } 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\" ; import { ExampleClusterFeatureSettings } from \"./src/example-cluster-feature-settings\" import React from \"react\" export default class ExampleExtension extends Renderer . LensExtension { entitySettings = [ { apiVersions : [ \"entity.k8slens.dev/v1alpha1\" ], kind : \"KubernetesCluster\" , title : \"Example Cluster Feature\" , priority : 5 , components : { View : ({ entity = null } : { entity : Common.Catalog.KubernetesCluster }) => ( < ExampleClusterFeatureSettings cluster = { entity } /> ) } } ]; } 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.","title":"Resource Stack"},{"location":"extensions/guides/resource-stack/#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 kind : Pod metadata : name : example-pod spec : containers : - name : example-pod image : nginx 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\" ; import * as path from \"path\" ; const { K8sApi : { ResourceStack , forCluster , Pod , } } = Renderer ; type ResourceStack = Renderer . K8sApi . ResourceStack ; type Pod = Renderer . K8sApi . Pod ; type KubernetesCluster = Common . Catalog . KubernetesCluster ; export class ExampleClusterFeature { protected stack : ResourceStack ; constructor ( protected cluster : KubernetesCluster ) { this . stack = new ResourceStack ( cluster , \"example-resource-stack\" ); } get resourceFolder () { return path . join ( __dirname , \"../resources/\" ); } install () : Promise < string > { console . log ( \"installing example-pod\" ); return this . stack . kubectlApplyFolder ( this . resourceFolder ); } async isInstalled () : Promise < boolean > { try { const podApi = forCluster ( this . cluster , Pod ); const examplePod = await podApi . get ({ name : \"example-pod\" , namespace : \"default\" }); if ( examplePod ? . kind ) { console . log ( \"found example-pod\" ); return true ; } } catch ( e ) { console . log ( \"Error getting example-pod:\" , e ); } console . log ( \"didn't find example-pod\" ); return false ; } async uninstall () : Promise < string > { console . log ( \"uninstalling example-pod\" ); return this . stack . kubectlDeleteFolder ( this . resourceFolder ); } } 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\" ; import { Common , Renderer } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import { computed , observable , makeObservable } from \"mobx\" ; import { ExampleClusterFeature } from \"./example-cluster-feature\" ; const { Component : { SubTitle , Button , } } = Renderer ; interface ExampleClusterFeatureSettingsProps { cluster : Common.Catalog.KubernetesCluster ; } @observer export class ExampleClusterFeatureSettings extends React . Component < ExampleClusterFeatureSettingsProps > { constructor ( props : ExampleClusterFeatureSettingsProps ) { super ( props ); makeObservable ( this ); } @observable installed = false ; @observable inProgress = false ; feature : ExampleClusterFeature ; async componentDidMount () { this . feature = new ExampleClusterFeature ( this . props . cluster ); await this . updateFeatureState (); } async updateFeatureState () { this . installed = await this . feature . isInstalled (); } async save () { this . inProgress = true ; try { if ( this . installed ) { await this . feature . uninstall (); } else { await this . feature . install (); } } finally { this . inProgress = false ; await this . updateFeatureState (); } } @computed get buttonLabel () { if ( this . inProgress && this . installed ) return \"Uninstalling ...\" ; if ( this . inProgress ) return \"Applying ...\" ; if ( this . installed ) { return \"Uninstall\" ; } return \"Apply\" ; } render () { return ( <> < section > < SubTitle title = \"Example Cluster Feature using a Resource Stack\" /> < Button label = { this . buttonLabel } waiting = { this . inProgress } onClick = {() => this . save ()} primary /> < /section> < /> ); } } 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\" ; import { ExampleClusterFeatureSettings } from \"./src/example-cluster-feature-settings\" import React from \"react\" export default class ExampleExtension extends Renderer . LensExtension { entitySettings = [ { apiVersions : [ \"entity.k8slens.dev/v1alpha1\" ], kind : \"KubernetesCluster\" , title : \"Example Cluster Feature\" , priority : 5 , components : { View : ({ entity = null } : { entity : Common.Catalog.KubernetesCluster }) => ( < ExampleClusterFeatureSettings cluster = { entity } /> ) } } ]; } 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.","title":"Resource Stack (Cluster Feature)"},{"location":"extensions/guides/stores/","text":"Stores # Stores are components that persist and synchronize state data. Lens uses a number of stores to maintain various kinds of state information, including: The ClusterStore manages cluster state data (such as cluster details), and it tracks which cluster is active. The WorkspaceStore manages workspace state data (such as the workspace name), and and it tracks which clusters belong to a given workspace. The ExtensionStore manages custom extension state data. This guide focuses on the ExtensionStore . 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\" ; import { observable , makeObservable } from \"mobx\" ; export type ExamplePreferencesModel = { enabled : boolean ; }; export class ExamplePreferencesStore extends Common . Store . ExtensionStore < ExamplePreferencesModel > { @observable enabled = false ; private constructor () { super ({ configName : \"example-preferences-store\" , defaults : { enabled : false } }); makeObservable ( this ); } protected fromStore ({ enabled } : ExamplePreferencesModel ) : void { this . enabled = enabled ; } toJSON () : ExamplePreferencesModel { return { enabled : this.enabled }; } } 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\" ; import { ExamplePreferencesStore } from \"./src/example-preference-store\" ; export default class ExampleMainExtension extends Main . LensExtension { async onActivate () { await ExamplePreferencesStore . getInstanceOrCreate (). loadExtension ( this ); } } 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\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { ExamplePreferencesStore } from \"./src/example-preference-store\" ; import React from \"react\" ; export default class ExampleRendererExtension extends Renderer . LensExtension { async onActivate () { await ExamplePreferencesStore . getInstanceOrCreate (). loadExtension ( this ); } appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput /> , Hint : () => < ExamplePreferenceHint /> } } ]; } 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\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; import { ExamplePreferencesStore } from \"./example-preference-store\" ; const { Component : { Checkbox , }, } = Renderer ; @observer export class ExamplePreferenceInput extends React . Component { render () { return ( < Checkbox label = \"I understand appPreferences\" value = { ExamplePreferencesStore . getInstance (). enabled } onChange = { v => { ExamplePreferencesStore . getInstance (). enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render () { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } 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 .","title":"Stores"},{"location":"extensions/guides/stores/#stores","text":"Stores are components that persist and synchronize state data. Lens uses a number of stores to maintain various kinds of state information, including: The ClusterStore manages cluster state data (such as cluster details), and it tracks which cluster is active. The WorkspaceStore manages workspace state data (such as the workspace name), and and it tracks which clusters belong to a given workspace. The ExtensionStore manages custom extension state data. This guide focuses on the ExtensionStore .","title":"Stores"},{"location":"extensions/guides/stores/#extensionstore","text":"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\" ; import { observable , makeObservable } from \"mobx\" ; export type ExamplePreferencesModel = { enabled : boolean ; }; export class ExamplePreferencesStore extends Common . Store . ExtensionStore < ExamplePreferencesModel > { @observable enabled = false ; private constructor () { super ({ configName : \"example-preferences-store\" , defaults : { enabled : false } }); makeObservable ( this ); } protected fromStore ({ enabled } : ExamplePreferencesModel ) : void { this . enabled = enabled ; } toJSON () : ExamplePreferencesModel { return { enabled : this.enabled }; } } 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\" ; import { ExamplePreferencesStore } from \"./src/example-preference-store\" ; export default class ExampleMainExtension extends Main . LensExtension { async onActivate () { await ExamplePreferencesStore . getInstanceOrCreate (). loadExtension ( this ); } } 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\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { ExamplePreferencesStore } from \"./src/example-preference-store\" ; import React from \"react\" ; export default class ExampleRendererExtension extends Renderer . LensExtension { async onActivate () { await ExamplePreferencesStore . getInstanceOrCreate (). loadExtension ( this ); } appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput /> , Hint : () => < ExamplePreferenceHint /> } } ]; } 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\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; import { ExamplePreferencesStore } from \"./example-preference-store\" ; const { Component : { Checkbox , }, } = Renderer ; @observer export class ExamplePreferenceInput extends React . Component { render () { return ( < Checkbox label = \"I understand appPreferences\" value = { ExamplePreferencesStore . getInstance (). enabled } onChange = { v => { ExamplePreferencesStore . getInstance (). enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render () { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } 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 .","title":"ExtensionStore"},{"location":"extensions/guides/working-with-mobx/","text":"Working with MobX # Introduction # 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. React does some optimizations around re-rendering components after quick successions of setState calls. How MobX Works: # 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 .","title":"Working with MobX"},{"location":"extensions/guides/working-with-mobx/#working-with-mobx","text":"","title":"Working with MobX"},{"location":"extensions/guides/working-with-mobx/#introduction","text":"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. React does some optimizations around re-rendering components after quick successions of setState calls.","title":"Introduction"},{"location":"extensions/guides/working-with-mobx/#how-mobx-works","text":"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 .","title":"How MobX Works:"},{"location":"extensions/testing-and-publishing/bundling/","text":"","title":"Bundling"},{"location":"extensions/testing-and-publishing/publishing/","text":"Publishing Extensions # 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. Places To Host Your Extension # 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. Publishing via NPM # 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. Run npm version to bump the version of your extension by the appropriate amount. Run npm publish to publish your extension to NPM Run git 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 dist.tarball This will output the link that they will need to give to Lens to install your extension. Publish via GitHub Releases # 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. Making a NPM Tarball of Your Extension # 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 This will create a NPM tarball that can be hosted on GitHub Releases or any other publicly available file hosting service.","title":"Publishing Extensions"},{"location":"extensions/testing-and-publishing/publishing/#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.","title":"Publishing Extensions"},{"location":"extensions/testing-and-publishing/publishing/#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.","title":"Places To Host Your Extension"},{"location":"extensions/testing-and-publishing/publishing/#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. Run npm version to bump the version of your extension by the appropriate amount. Run npm publish to publish your extension to NPM Run git 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 dist.tarball This will output the link that they will need to give to Lens to install your extension.","title":"Publishing via NPM"},{"location":"extensions/testing-and-publishing/publishing/#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.","title":"Publish via GitHub Releases"},{"location":"extensions/testing-and-publishing/publishing/#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 This will create a NPM tarball that can be hosted on GitHub Releases or any other publicly available file hosting service.","title":"Making a NPM Tarball of Your Extension"},{"location":"extensions/testing-and-publishing/testing/","text":"Testing Extensions # Renderer Process Unit Testing # 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\" import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , }, } = Renderer ; const GlobalPageMenuIcon = ({ navigate } : { navigate ?: () => void }) : JSX . Element => ( < Icon material = \"trip_origin\" onClick = {() => navigate ()} data - testid = \"global-page-menu-icon\" /> ) The test import React from \"react\" import { render , screen , fireEvent } from \"@testing-library/react\" ; import GlobalPageMenuIcon from \"./GlobalPageMenuIcon\" ; test ( \"click called navigate()\" , () => { const navigate = jest . fn (); render ( < GlobalPageMenuIcon navigate = { navigate } /> ); fireEvent . click ( screen . getByTestId ( \"global-page-menu-icon\" )); expect ( navigate ). toHaveBeenCalled (); }); 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. Main Process Unit Testing # 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. Tips # Console.log # 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 . Renderer Process Logs # In the Renderer process, console.log() is printed in the Console in Developer Tools ( View > Toggle Developer Tools ). Main Process Logs # Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools. macOS # On macOS, view the Main process logs by running Lens from the terminal: /Applications/Lens.app/Contents/MacOS/Lens You can also use Console.app to view the Main process logs. Linux # On Linux, you can access the Main process logs using the Lens PID. First get the PID: ps aux | grep Lens | grep -v grep Then get the Main process logs using the PID: tail -f /proc/ [ pid ] /fd/1 # stdout (console.log) tail -f /proc/ [ pid ] /fd/2 # stdout (console.error)","title":"Testing Extensions"},{"location":"extensions/testing-and-publishing/testing/#testing-extensions","text":"","title":"Testing Extensions"},{"location":"extensions/testing-and-publishing/testing/#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\" import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , }, } = Renderer ; const GlobalPageMenuIcon = ({ navigate } : { navigate ?: () => void }) : JSX . Element => ( < Icon material = \"trip_origin\" onClick = {() => navigate ()} data - testid = \"global-page-menu-icon\" /> ) The test import React from \"react\" import { render , screen , fireEvent } from \"@testing-library/react\" ; import GlobalPageMenuIcon from \"./GlobalPageMenuIcon\" ; test ( \"click called navigate()\" , () => { const navigate = jest . fn (); render ( < GlobalPageMenuIcon navigate = { navigate } /> ); fireEvent . click ( screen . getByTestId ( \"global-page-menu-icon\" )); expect ( navigate ). toHaveBeenCalled (); }); 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.","title":"Renderer Process Unit Testing"},{"location":"extensions/testing-and-publishing/testing/#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.","title":"Main Process Unit Testing"},{"location":"extensions/testing-and-publishing/testing/#tips","text":"","title":"Tips"},{"location":"extensions/testing-and-publishing/testing/#consolelog","text":"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 .","title":"Console.log"},{"location":"extensions/testing-and-publishing/testing/#renderer-process-logs","text":"In the Renderer process, console.log() is printed in the Console in Developer Tools ( View > Toggle Developer Tools ).","title":"Renderer Process Logs"},{"location":"extensions/testing-and-publishing/testing/#main-process-logs","text":"Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools.","title":"Main Process Logs"},{"location":"extensions/usage/","text":"Using Extensions # 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. Installing an Extension # 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\\\\.k8slens\\extensions ) folder and Lens will automatically detect it and install the extension. Enabling or Disabling an 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. Uninstalling an Extension # 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.","title":"Using Extensions"},{"location":"extensions/usage/#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.","title":"Using Extensions"},{"location":"extensions/usage/#installing-an-extension","text":"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\\\\.k8slens\\extensions ) folder and Lens will automatically detect it and install the extension.","title":"Installing an Extension"},{"location":"extensions/usage/#enabling-or-disabling-an-extension","text":"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.","title":"Enabling or Disabling an Extension"},{"location":"extensions/usage/#uninstalling-an-extension","text":"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.","title":"Uninstalling an Extension"}]} \ No newline at end of file +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Lens Extension API # 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: How to build, run, test, and publish an extension. How to take full advantage of the Lens Extension API. Where to find guides and code samples to help get you started. What Extensions Can Do # Here are some examples of what you can achieve with the Extension API: Add custom components & views in the UI - Extending the Lens Workbench 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. How to Build Extensions # Here is what each section of the Lens Extension API docs can help you with: Getting Started teaches fundamental concepts for building extensions with the Hello World sample. Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics. Extension Guides includes guides and code samples that explain specific usages of Lens Extension API. Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions. API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics. What's New # 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 . Important changes since Lens v4 # 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. Looking for Help # If you have questions for extension development, try asking on the Lens Dev Slack . 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 . Downloading Lens # Download Lens for macOS, Windows, or Linux.","title":"Overview"},{"location":"#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: How to build, run, test, and publish an extension. How to take full advantage of the Lens Extension API. Where to find guides and code samples to help get you started.","title":"Lens Extension API"},{"location":"#what-extensions-can-do","text":"Here are some examples of what you can achieve with the Extension API: Add custom components & views in the UI - Extending the Lens Workbench 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.","title":"What Extensions Can Do"},{"location":"#how-to-build-extensions","text":"Here is what each section of the Lens Extension API docs can help you with: Getting Started teaches fundamental concepts for building extensions with the Hello World sample. Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics. Extension Guides includes guides and code samples that explain specific usages of Lens Extension API. Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions. API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics.","title":"How to Build Extensions"},{"location":"#whats-new","text":"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 .","title":"What's New"},{"location":"#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.","title":"Important changes since Lens v4"},{"location":"#looking-for-help","text":"If you have questions for extension development, try asking on the Lens Dev Slack . 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 .","title":"Looking for Help"},{"location":"#downloading-lens","text":"Download Lens for macOS, Windows, or Linux.","title":"Downloading Lens"},{"location":"architecture/decisions/","text":"Architecture Decision Records #","title":"Architecture Decision Records"},{"location":"architecture/decisions/#architecture-decision-records","text":"","title":"Architecture Decision Records"},{"location":"extensions/extension-migration/","text":"Lens v4 to v5 Extension Migration Notes # Lens v5 inspects the version of the extension to ensure it is compatible. The package.json for your extension must have an \"engines\" field specifying the lens version that your extension is targeted for, e.g: \"engines\": { \"lens\": \"^5.0.0-beta.7\" }, Note that Lens v5 supports all the range semantics that semver provides. Types and components have been reorganized, many have been grouped by process ( 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. The 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. The 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. Lens v5 now relies on mobx 6 for state management. Extensions that use mobx will need to be modified to work with mobx 6. See Migrating from Mobx 4/5 for specific details. For an example of an existing extension that is compatible with Lens v5 see the Lens Resource Map Extension","title":"Lens v4 to v5 Extension Migration Notes"},{"location":"extensions/extension-migration/#lens-v4-to-v5-extension-migration-notes","text":"Lens v5 inspects the version of the extension to ensure it is compatible. The package.json for your extension must have an \"engines\" field specifying the lens version that your extension is targeted for, e.g: \"engines\": { \"lens\": \"^5.0.0-beta.7\" }, Note that Lens v5 supports all the range semantics that semver provides. Types and components have been reorganized, many have been grouped by process ( 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. The 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. The 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. Lens v5 now relies on mobx 6 for state management. Extensions that use mobx will need to be modified to work with mobx 6. See Migrating from Mobx 4/5 for specific details. For an example of an existing extension that is compatible with Lens v5 see the Lens Resource Map Extension","title":"Lens v4 to v5 Extension Migration Notes"},{"location":"extensions/api/","text":"Extension API Reference # APIs # Common Main Renderer","title":"API Reference"},{"location":"extensions/api/#extension-api-reference","text":"","title":"Extension API Reference"},{"location":"extensions/api/#apis","text":"Common Main Renderer","title":"APIs"},{"location":"extensions/api/modules/","text":"@k8slens/extensions # Table of contents # Namespaces # Common Main Renderer","title":"@k8slens/extensions"},{"location":"extensions/api/modules/#k8slensextensions","text":"","title":"@k8slens/extensions"},{"location":"extensions/api/modules/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/#namespaces","text":"Common Main Renderer","title":"Namespaces"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/","text":"Class: CatalogCategory # Common . Catalog .CatalogCategory Hierarchy # CatalogCategory_base \u21b3 CatalogCategory \u21b3\u21b3 KubernetesClusterCategory Table of contents # Constructors # constructor Properties # apiVersion filters kind metadata spec Methods # addMenuFilter filteredItems getBadge getId getName parseId Constructors # constructor # \u2022 new CatalogCategory () Inherited from # CatalogCategory_base.constructor Properties # apiVersion # \u2022 Readonly Abstract apiVersion : string The version of category that you are wanting to declare. Currently supported values: \"catalog.k8slens.dev/v1alpha1\" filters # \u2022 Protected Readonly filters : ObservableSet < AddMenuFilter > kind # \u2022 Readonly Abstract kind : string The kind of item you wish to declare. Currently supported values: \"CatalogCategory\" metadata # \u2022 Readonly Abstract metadata : CatalogCategoryMetadata The data about the category itself spec # \u2022 Readonly Abstract spec : CatalogCategorySpec The most important part of a category, as it is where entity versions are declared. Methods # addMenuFilter # \u25b8 addMenuFilter ( fn ): Disposer Add a filter for menu items of catalogAddMenu Parameters # Name Type Description fn AddMenuFilter The function that should return a truthy value if that menu item should be displayed Returns # Disposer A function to remove that filter filteredItems # \u25b8 filteredItems ( menuItems ): CatalogEntityAddMenu [] Filter menuItems according to the Category's set filters Parameters # Name Type Description menuItems CatalogEntityAddMenu [] menu items to filter Returns # CatalogEntityAddMenu [] filtered menu items getBadge # \u25b8 getBadge (): ReactNode Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu Returns # ReactNode getId # \u25b8 getId (): string Get the ID of this category Returns # string getName # \u25b8 getName (): string Get the name of this category Returns # string parseId # \u25b8 Static parseId ( id ): Object Parse a category ID into parts. Parameters # Name Type Description id string The id of a category is parse Returns # Object The group and kind parts of the ID Name Type group? string kind? string","title":"Class: CatalogCategory"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#class-catalogcategory","text":"Common . Catalog .CatalogCategory","title":"Class: CatalogCategory"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#hierarchy","text":"CatalogCategory_base \u21b3 CatalogCategory \u21b3\u21b3 KubernetesClusterCategory","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#properties","text":"apiVersion filters kind metadata spec","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#methods","text":"addMenuFilter filteredItems getBadge getId getName parseId","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#constructor","text":"\u2022 new CatalogCategory ()","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#apiversion","text":"\u2022 Readonly Abstract apiVersion : string The version of category that you are wanting to declare. Currently supported values: \"catalog.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#filters","text":"\u2022 Protected Readonly filters : ObservableSet < AddMenuFilter >","title":"filters"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#kind","text":"\u2022 Readonly Abstract kind : string The kind of item you wish to declare. Currently supported values: \"CatalogCategory\"","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#metadata","text":"\u2022 Readonly Abstract metadata : CatalogCategoryMetadata The data about the category itself","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#spec","text":"\u2022 Readonly Abstract spec : CatalogCategorySpec The most important part of a category, as it is where entity versions are declared.","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#addmenufilter","text":"\u25b8 addMenuFilter ( fn ): Disposer Add a filter for menu items of catalogAddMenu","title":"addMenuFilter"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#filtereditems","text":"\u25b8 filteredItems ( menuItems ): CatalogEntityAddMenu [] Filter menuItems according to the Category's set filters","title":"filteredItems"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getbadge","text":"\u25b8 getBadge (): ReactNode Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu","title":"getBadge"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getid","text":"\u25b8 getId (): string Get the ID of this category","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getname","text":"\u25b8 getName (): string Get the name of this category","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#parseid","text":"\u25b8 Static parseId ( id ): Object Parse a category ID into parts.","title":"parseId"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/","text":"Class: CatalogEntity # Common . Catalog .CatalogEntity Type parameters # Name Type Metadata extends CatalogEntityMetadata = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec Hierarchy # CatalogEntity \u21b3 KubernetesCluster \u21b3 GeneralEntity \u21b3 WebLink Implements # CatalogEntityKindData Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status Methods # getId getName getSource isEnabled onContextMenuOpen onRun onSettingsOpen Constructors # constructor # \u2022 new CatalogEntity < Metadata , Status , Spec >( \u00abdestructured\u00bb ) Type parameters # Name Type Metadata extends CatalogEntityMetadata < Metadata > = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec Parameters # Name Type \u00abdestructured\u00bb CatalogEntityData < Metadata , Status , Spec > Properties # apiVersion # \u2022 Readonly Abstract apiVersion : string The group and version of this class. Implementation of # CatalogEntityKindData . apiVersion kind # \u2022 Readonly Abstract kind : string A DNS label name of the entity. Implementation of # CatalogEntityKindData . kind metadata # \u2022 metadata : Metadata spec # \u2022 spec : Spec status # \u2022 status : Status Methods # getId # \u25b8 getId (): string Get the UID of this entity Returns # string getName # \u25b8 getName (): string Get the name of this entity Returns # string getSource # \u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided Returns # string isEnabled # \u25b8 isEnabled (): boolean Get if this entity is enabled. Returns # boolean onContextMenuOpen # \u25b8 Optional onContextMenuOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntityContextMenuContext Returns # void | Promise < void > onRun # \u25b8 Optional onRun ( context ): void | Promise < void > Parameters # Name Type context CatalogEntityActionContext Returns # void | Promise < void > onSettingsOpen # \u25b8 Optional onSettingsOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntitySettingsContext Returns # void | Promise < void >","title":"Class: CatalogEntity"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#class-catalogentitymetadata-status-spec","text":"Common . Catalog .CatalogEntity","title":"Class: CatalogEntity<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#type-parameters","text":"Name Type Metadata extends CatalogEntityMetadata = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec","title":"Type parameters"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#hierarchy","text":"CatalogEntity \u21b3 KubernetesCluster \u21b3 GeneralEntity \u21b3 WebLink","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#implements","text":"CatalogEntityKindData","title":"Implements"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#properties","text":"apiVersion kind metadata spec status","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#methods","text":"getId getName getSource isEnabled onContextMenuOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#constructor","text":"\u2022 new CatalogEntity < Metadata , Status , Spec >( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#apiversion","text":"\u2022 Readonly Abstract apiVersion : string The group and version of this class.","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#kind","text":"\u2022 Readonly Abstract kind : string A DNS label name of the entity.","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#spec","text":"\u2022 spec : Spec","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#status","text":"\u2022 status : Status","title":"status"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getid","text":"\u25b8 getId (): string Get the UID of this entity","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getname","text":"\u25b8 getName (): string Get the name of this entity","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getsource","text":"\u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided","title":"getSource"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#isenabled","text":"\u25b8 isEnabled (): boolean Get if this entity is enabled.","title":"isEnabled"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#oncontextmenuopen","text":"\u25b8 Optional onContextMenuOpen ( context ): void | Promise < void >","title":"onContextMenuOpen"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#onrun","text":"\u25b8 Optional onRun ( context ): void | Promise < void >","title":"onRun"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#onsettingsopen","text":"\u25b8 Optional onSettingsOpen ( context ): void | Promise < void >","title":"onSettingsOpen"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/","text":"Class: GeneralEntity # Common . Catalog .GeneralEntity Hierarchy # CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec > \u21b3 GeneralEntity Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status Methods # getId getName getSource isEnabled onContextMenuOpen onRun onSettingsOpen Constructors # constructor # \u2022 new GeneralEntity ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb CatalogEntityData < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" The group and version of this class. Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : \"General\" A DNS label name of the entity. Overrides # CatalogEntity . kind metadata # \u2022 metadata : CatalogEntityMetadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : GeneralEntitySpec Inherited from # CatalogEntity . spec status # \u2022 status : CatalogEntityStatus Inherited from # CatalogEntity . status Methods # getId # \u25b8 getId (): string Get the UID of this entity Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Get the name of this entity Returns # string Inherited from # CatalogEntity . getName getSource # \u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided Returns # string Inherited from # CatalogEntity . getSource isEnabled # \u25b8 isEnabled (): boolean Get if this entity is enabled. Returns # boolean Inherited from # CatalogEntity . isEnabled onContextMenuOpen # \u25b8 Optional onContextMenuOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntityContextMenuContext Returns # void | Promise < void > Inherited from # CatalogEntity . onContextMenuOpen onRun # \u25b8 onRun ( context ): Promise < void > Parameters # Name Type context CatalogEntityActionContext Returns # Promise < void > Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 Optional onSettingsOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntitySettingsContext Returns # void | Promise < void > Inherited from # CatalogEntity . onSettingsOpen","title":"Class: GeneralEntity"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#class-generalentity","text":"Common . Catalog .GeneralEntity","title":"Class: GeneralEntity"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#hierarchy","text":"CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec > \u21b3 GeneralEntity","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#properties","text":"apiVersion kind metadata spec status","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#methods","text":"getId getName getSource isEnabled onContextMenuOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#constructor","text":"\u2022 new GeneralEntity ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#apiversion","text":"\u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" The group and version of this class.","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#kind","text":"\u2022 Readonly kind : \"General\" A DNS label name of the entity.","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#metadata","text":"\u2022 metadata : CatalogEntityMetadata","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#spec","text":"\u2022 spec : GeneralEntitySpec","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#status","text":"\u2022 status : CatalogEntityStatus","title":"status"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getid","text":"\u25b8 getId (): string Get the UID of this entity","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getname","text":"\u25b8 getName (): string Get the name of this entity","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getsource","text":"\u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided","title":"getSource"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#isenabled","text":"\u25b8 isEnabled (): boolean Get if this entity is enabled.","title":"isEnabled"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#oncontextmenuopen","text":"\u25b8 Optional onContextMenuOpen ( context ): void | Promise < void >","title":"onContextMenuOpen"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#onrun","text":"\u25b8 onRun ( context ): Promise < void >","title":"onRun"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#onsettingsopen","text":"\u25b8 Optional onSettingsOpen ( context ): void | Promise < void >","title":"onSettingsOpen"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/","text":"Class: KubernetesCluster # Common . Catalog .KubernetesCluster Type parameters # Name Type Metadata extends KubernetesClusterMetadata = KubernetesClusterMetadata Status extends KubernetesClusterStatus = KubernetesClusterStatus Spec extends KubernetesClusterSpec = KubernetesClusterSpec Hierarchy # CatalogEntity < Metadata , Status , Spec > \u21b3 KubernetesCluster Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiVersion kind Methods # connect disconnect getId getName getSource isEnabled onContextMenuOpen onDetailsOpen onRun onSettingsOpen Constructors # constructor # \u2022 new KubernetesCluster < Metadata , Status , Spec >( \u00abdestructured\u00bb ) Type parameters # Name Type Metadata extends KubernetesClusterMetadata < Metadata > = KubernetesClusterMetadata Status extends KubernetesClusterStatus = KubernetesClusterStatus Spec extends KubernetesClusterSpec < Spec > = KubernetesClusterSpec Parameters # Name Type \u00abdestructured\u00bb CatalogEntityData < Metadata , Status , Spec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : string The group and version of this class. Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : string A DNS label name of the entity. Overrides # CatalogEntity . kind metadata # \u2022 metadata : Metadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : Spec Inherited from # CatalogEntity . spec status # \u2022 status : Status Inherited from # CatalogEntity . status apiVersion # \u25aa Static Readonly apiVersion : string kind # \u25aa Static Readonly kind : string Methods # connect # \u25b8 connect (): Promise < void > Returns # Promise < void > disconnect # \u25b8 disconnect (): Promise < void > Returns # Promise < void > getId # \u25b8 getId (): string Get the UID of this entity Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Get the name of this entity Returns # string Inherited from # CatalogEntity . getName getSource # \u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided Returns # string Inherited from # CatalogEntity . getSource isEnabled # \u25b8 isEnabled (): boolean Get if this entity is enabled. Returns # boolean Inherited from # CatalogEntity . isEnabled onContextMenuOpen # \u25b8 onContextMenuOpen ( context ): void Parameters # Name Type context CatalogEntityContextMenuContext Returns # void Overrides # CatalogEntity . onContextMenuOpen onDetailsOpen # \u25b8 onDetailsOpen (): void Returns # void onRun # \u25b8 onRun ( context ): Promise < void > Parameters # Name Type context CatalogEntityActionContext Returns # Promise < void > Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 onSettingsOpen (): void Returns # void Overrides # CatalogEntity . onSettingsOpen","title":"Class: KubernetesCluster"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#class-kubernetesclustermetadata-status-spec","text":"Common . Catalog .KubernetesCluster","title":"Class: KubernetesCluster<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#type-parameters","text":"Name Type Metadata extends KubernetesClusterMetadata = KubernetesClusterMetadata Status extends KubernetesClusterStatus = KubernetesClusterStatus Spec extends KubernetesClusterSpec = KubernetesClusterSpec","title":"Type parameters"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#hierarchy","text":"CatalogEntity < Metadata , Status , Spec > \u21b3 KubernetesCluster","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#properties","text":"apiVersion kind metadata spec status apiVersion kind","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#methods","text":"connect disconnect getId getName getSource isEnabled onContextMenuOpen onDetailsOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#constructor","text":"\u2022 new KubernetesCluster < Metadata , Status , Spec >( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#apiversion","text":"\u2022 Readonly apiVersion : string The group and version of this class.","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#kind","text":"\u2022 Readonly kind : string A DNS label name of the entity.","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#spec","text":"\u2022 spec : Spec","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#status","text":"\u2022 status : Status","title":"status"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#apiversion_1","text":"\u25aa Static Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#kind_1","text":"\u25aa Static Readonly kind : string","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#connect","text":"\u25b8 connect (): Promise < void >","title":"connect"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#disconnect","text":"\u25b8 disconnect (): Promise < void >","title":"disconnect"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getid","text":"\u25b8 getId (): string Get the UID of this entity","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getname","text":"\u25b8 getName (): string Get the name of this entity","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getsource","text":"\u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided","title":"getSource"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#isenabled","text":"\u25b8 isEnabled (): boolean Get if this entity is enabled.","title":"isEnabled"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#oncontextmenuopen","text":"\u25b8 onContextMenuOpen ( context ): void","title":"onContextMenuOpen"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#ondetailsopen","text":"\u25b8 onDetailsOpen (): void","title":"onDetailsOpen"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#onrun","text":"\u25b8 onRun ( context ): Promise < void >","title":"onRun"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#onsettingsopen","text":"\u25b8 onSettingsOpen (): void","title":"onSettingsOpen"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/","text":"Class: KubernetesClusterCategory # Common . Catalog .KubernetesClusterCategory Hierarchy # CatalogCategory \u21b3 KubernetesClusterCategory Table of contents # Constructors # constructor Properties # apiVersion filters kind metadata spec Methods # addMenuFilter filteredItems getBadge getId getName parseId Constructors # constructor # \u2022 new KubernetesClusterCategory () Inherited from # CatalogCategory . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"catalog.k8slens.dev/v1alpha1\" The version of category that you are wanting to declare. Currently supported values: \"catalog.k8slens.dev/v1alpha1\" Overrides # CatalogCategory . apiVersion filters # \u2022 Protected Readonly filters : ObservableSet < AddMenuFilter > Inherited from # CatalogCategory . filters kind # \u2022 Readonly kind : \"CatalogCategory\" The kind of item you wish to declare. Currently supported values: \"CatalogCategory\" Overrides # CatalogCategory . kind metadata # \u2022 metadata : Object The data about the category itself Type declaration # Name Type icon string name string Overrides # CatalogCategory . metadata spec # \u2022 spec : CatalogCategorySpec The most important part of a category, as it is where entity versions are declared. Overrides # CatalogCategory . spec Methods # addMenuFilter # \u25b8 addMenuFilter ( fn ): Disposer Add a filter for menu items of catalogAddMenu Parameters # Name Type Description fn AddMenuFilter The function that should return a truthy value if that menu item should be displayed Returns # Disposer A function to remove that filter Inherited from # CatalogCategory . addMenuFilter filteredItems # \u25b8 filteredItems ( menuItems ): CatalogEntityAddMenu [] Filter menuItems according to the Category's set filters Parameters # Name Type Description menuItems CatalogEntityAddMenu [] menu items to filter Returns # CatalogEntityAddMenu [] filtered menu items Inherited from # CatalogCategory . filteredItems getBadge # \u25b8 getBadge (): ReactNode Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu Returns # ReactNode Inherited from # CatalogCategory . getBadge getId # \u25b8 getId (): string Get the ID of this category Returns # string Inherited from # CatalogCategory . getId getName # \u25b8 getName (): string Get the name of this category Returns # string Inherited from # CatalogCategory . getName parseId # \u25b8 Static parseId ( id ): Object Parse a category ID into parts. Parameters # Name Type Description id string The id of a category is parse Returns # Object The group and kind parts of the ID Name Type group? string kind? string Inherited from # CatalogCategory . parseId","title":"Class: KubernetesClusterCategory"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#class-kubernetesclustercategory","text":"Common . Catalog .KubernetesClusterCategory","title":"Class: KubernetesClusterCategory"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#hierarchy","text":"CatalogCategory \u21b3 KubernetesClusterCategory","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#properties","text":"apiVersion filters kind metadata spec","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#methods","text":"addMenuFilter filteredItems getBadge getId getName parseId","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#constructor","text":"\u2022 new KubernetesClusterCategory ()","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#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\"","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#filters","text":"\u2022 Protected Readonly filters : ObservableSet < AddMenuFilter >","title":"filters"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#kind","text":"\u2022 Readonly kind : \"CatalogCategory\" The kind of item you wish to declare. Currently supported values: \"CatalogCategory\"","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#metadata","text":"\u2022 metadata : Object The data about the category itself","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#spec","text":"\u2022 spec : CatalogCategorySpec The most important part of a category, as it is where entity versions are declared.","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#addmenufilter","text":"\u25b8 addMenuFilter ( fn ): Disposer Add a filter for menu items of catalogAddMenu","title":"addMenuFilter"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#filtereditems","text":"\u25b8 filteredItems ( menuItems ): CatalogEntityAddMenu [] Filter menuItems according to the Category's set filters","title":"filteredItems"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#getbadge","text":"\u25b8 getBadge (): ReactNode Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu","title":"getBadge"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#getid","text":"\u25b8 getId (): string Get the ID of this category","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#getname","text":"\u25b8 getName (): string Get the name of this category","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.KubernetesClusterCategory/#parseid","text":"\u25b8 Static parseId ( id ): Object Parse a category ID into parts.","title":"parseId"},{"location":"extensions/api/classes/Common.Catalog.WebLink/","text":"Class: WebLink # Common . Catalog .WebLink Hierarchy # CatalogEntity < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > \u21b3 WebLink Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiVersion kind Methods # getId getName getSource isEnabled onContextMenuOpen onRun onSettingsOpen Constructors # constructor # \u2022 new WebLink ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb CatalogEntityData < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" The group and version of this class. Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : \"WebLink\" A DNS label name of the entity. Overrides # CatalogEntity . kind metadata # \u2022 metadata : CatalogEntityMetadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : WebLinkSpec Inherited from # CatalogEntity . spec status # \u2022 status : WebLinkStatus Inherited from # CatalogEntity . status apiVersion # \u25aa Static Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" kind # \u25aa Static Readonly kind : \"WebLink\" Methods # getId # \u25b8 getId (): string Get the UID of this entity Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Get the name of this entity Returns # string Inherited from # CatalogEntity . getName getSource # \u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided Returns # string Inherited from # CatalogEntity . getSource isEnabled # \u25b8 isEnabled (): boolean Get if this entity is enabled. Returns # boolean Inherited from # CatalogEntity . isEnabled onContextMenuOpen # \u25b8 onContextMenuOpen ( context ): void Parameters # Name Type context CatalogEntityContextMenuContext Returns # void Overrides # CatalogEntity . onContextMenuOpen onRun # \u25b8 onRun (): Promise < void > Returns # Promise < void > Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 Optional onSettingsOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntitySettingsContext Returns # void | Promise < void > Inherited from # CatalogEntity . onSettingsOpen","title":"Class: WebLink"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#class-weblink","text":"Common . Catalog .WebLink","title":"Class: WebLink"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#hierarchy","text":"CatalogEntity < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > \u21b3 WebLink","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#properties","text":"apiVersion kind metadata spec status apiVersion kind","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#methods","text":"getId getName getSource isEnabled onContextMenuOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#constructor","text":"\u2022 new WebLink ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#apiversion","text":"\u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" The group and version of this class.","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#kind","text":"\u2022 Readonly kind : \"WebLink\" A DNS label name of the entity.","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#metadata","text":"\u2022 metadata : CatalogEntityMetadata","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#spec","text":"\u2022 spec : WebLinkSpec","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#status","text":"\u2022 status : WebLinkStatus","title":"status"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#apiversion_1","text":"\u25aa Static Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#kind_1","text":"\u25aa Static Readonly kind : \"WebLink\"","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getid","text":"\u25b8 getId (): string Get the UID of this entity","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getname","text":"\u25b8 getName (): string Get the name of this entity","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getsource","text":"\u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided","title":"getSource"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#isenabled","text":"\u25b8 isEnabled (): boolean Get if this entity is enabled.","title":"isEnabled"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#oncontextmenuopen","text":"\u25b8 onContextMenuOpen ( context ): void","title":"onContextMenuOpen"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#onrun","text":"\u25b8 onRun (): Promise < void >","title":"onRun"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#onsettingsopen","text":"\u25b8 Optional onSettingsOpen ( context ): void | Promise < void >","title":"onSettingsOpen"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/","text":"Class: EventEmitter # Common . EventBus .EventEmitter Type parameters # Name Type D extends any [] Table of contents # Constructors # constructor Properties # listeners Methods # addListener emit removeAllListeners removeListener Constructors # constructor # \u2022 new EventEmitter < D >() Type parameters # Name Type D extends any [] Properties # listeners # \u2022 Protected listeners : [ EventEmitterCallback < D >, EventEmitterOptions ][] Methods # addListener # \u25b8 addListener ( callback , options? ): void Parameters # Name Type callback EventEmitterCallback < D > options? EventEmitterOptions Returns # void emit # \u25b8 emit ( ...data ): void Parameters # Name Type ...data D Returns # void removeAllListeners # \u25b8 removeAllListeners (): void Returns # void removeListener # \u25b8 removeListener ( callback ): void Parameters # Name Type callback EventEmitterCallback < D > Returns # void","title":"Class: EventEmitter"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#class-eventemitterd","text":"Common . EventBus .EventEmitter","title":"Class: EventEmitter<D>"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#type-parameters","text":"Name Type D extends any []","title":"Type parameters"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#properties","text":"listeners","title":"Properties"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#methods","text":"addListener emit removeAllListeners removeListener","title":"Methods"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#constructor","text":"\u2022 new EventEmitter < D >()","title":"constructor"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#listeners","text":"\u2022 Protected listeners : [ EventEmitterCallback < D >, EventEmitterOptions ][]","title":"listeners"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#addlistener","text":"\u25b8 addListener ( callback , options? ): void","title":"addListener"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#emit","text":"\u25b8 emit ( ...data ): void","title":"emit"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#removealllisteners","text":"\u25b8 removeAllListeners (): void","title":"removeAllListeners"},{"location":"extensions/api/classes/Common.EventBus.EventEmitter/#removelistener","text":"\u25b8 removeListener ( callback ): void","title":"removeListener"},{"location":"extensions/api/classes/Common.LensExtension/","text":"Class: LensExtension # Common .LensExtension Type parameters # Name Type Dependencies extends LensExtensionDependencies = LensExtensionDependencies Hierarchy # LensExtension \u21b3 LensExtension \u21b3 LensExtension Table of contents # Constructors # constructor Properties # id isBundled manifest manifestPath protocolHandlers Accessors # description isEnabled name sanitizedExtensionId storeName version Methods # activate disable enable getExtensionFileFolder onActivate onDeactivate Constructors # constructor # \u2022 new LensExtension < Dependencies >( \u00abdestructured\u00bb ) Type parameters # Name Type Dependencies extends LensExtensionDependencies = LensExtensionDependencies Parameters # Name Type \u00abdestructured\u00bb InstalledExtension Properties # id # \u2022 Readonly id : string isBundled # \u2022 Readonly isBundled : boolean manifest # \u2022 Readonly manifest : LensExtensionManifest manifestPath # \u2022 Readonly manifestPath : string protocolHandlers # \u2022 protocolHandlers : ProtocolHandlerRegistration [] Accessors # description # \u2022 get description (): undefined | string Returns # undefined | string isEnabled # \u2022 get isEnabled (): boolean Returns # boolean name # \u2022 get name (): string Returns # string sanitizedExtensionId # \u2022 get sanitizedExtensionId (): string Returns # string storeName # \u2022 get storeName (): string Returns # string version # \u2022 get version (): string Returns # string Methods # activate # \u25b8 activate (): Promise < void > Returns # Promise < void > disable # \u25b8 disable (): Promise < void > Returns # Promise < void > enable # \u25b8 enable (): Promise < void > Returns # Promise < void > getExtensionFileFolder # \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. Returns # Promise < string > onActivate # \u25b8 Protected onActivate (): void | Promise < void > Returns # void | Promise < void > onDeactivate # \u25b8 Protected onDeactivate (): void | Promise < void > Returns # void | Promise < void >","title":"Class: LensExtension"},{"location":"extensions/api/classes/Common.LensExtension/#class-lensextensiondependencies","text":"Common .LensExtension","title":"Class: LensExtension<Dependencies>"},{"location":"extensions/api/classes/Common.LensExtension/#type-parameters","text":"Name Type Dependencies extends LensExtensionDependencies = LensExtensionDependencies","title":"Type parameters"},{"location":"extensions/api/classes/Common.LensExtension/#hierarchy","text":"LensExtension \u21b3 LensExtension \u21b3 LensExtension","title":"Hierarchy"},{"location":"extensions/api/classes/Common.LensExtension/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.LensExtension/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.LensExtension/#properties","text":"id isBundled manifest manifestPath protocolHandlers","title":"Properties"},{"location":"extensions/api/classes/Common.LensExtension/#accessors","text":"description isEnabled name sanitizedExtensionId storeName version","title":"Accessors"},{"location":"extensions/api/classes/Common.LensExtension/#methods","text":"activate disable enable getExtensionFileFolder onActivate onDeactivate","title":"Methods"},{"location":"extensions/api/classes/Common.LensExtension/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.LensExtension/#constructor","text":"\u2022 new LensExtension < Dependencies >( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Common.LensExtension/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.LensExtension/#id","text":"\u2022 Readonly id : string","title":"id"},{"location":"extensions/api/classes/Common.LensExtension/#isbundled","text":"\u2022 Readonly isBundled : boolean","title":"isBundled"},{"location":"extensions/api/classes/Common.LensExtension/#manifest","text":"\u2022 Readonly manifest : LensExtensionManifest","title":"manifest"},{"location":"extensions/api/classes/Common.LensExtension/#manifestpath","text":"\u2022 Readonly manifestPath : string","title":"manifestPath"},{"location":"extensions/api/classes/Common.LensExtension/#protocolhandlers","text":"\u2022 protocolHandlers : ProtocolHandlerRegistration []","title":"protocolHandlers"},{"location":"extensions/api/classes/Common.LensExtension/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Common.LensExtension/#description","text":"\u2022 get description (): undefined | string","title":"description"},{"location":"extensions/api/classes/Common.LensExtension/#isenabled","text":"\u2022 get isEnabled (): boolean","title":"isEnabled"},{"location":"extensions/api/classes/Common.LensExtension/#name","text":"\u2022 get name (): string","title":"name"},{"location":"extensions/api/classes/Common.LensExtension/#sanitizedextensionid","text":"\u2022 get sanitizedExtensionId (): string","title":"sanitizedExtensionId"},{"location":"extensions/api/classes/Common.LensExtension/#storename","text":"\u2022 get storeName (): string","title":"storeName"},{"location":"extensions/api/classes/Common.LensExtension/#version","text":"\u2022 get version (): string","title":"version"},{"location":"extensions/api/classes/Common.LensExtension/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.LensExtension/#activate","text":"\u25b8 activate (): Promise < void >","title":"activate"},{"location":"extensions/api/classes/Common.LensExtension/#disable","text":"\u25b8 disable (): Promise < void >","title":"disable"},{"location":"extensions/api/classes/Common.LensExtension/#enable","text":"\u25b8 enable (): Promise < void >","title":"enable"},{"location":"extensions/api/classes/Common.LensExtension/#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.","title":"getExtensionFileFolder"},{"location":"extensions/api/classes/Common.LensExtension/#onactivate","text":"\u25b8 Protected onActivate (): void | Promise < void >","title":"onActivate"},{"location":"extensions/api/classes/Common.LensExtension/#ondeactivate","text":"\u25b8 Protected onDeactivate (): void | Promise < void >","title":"onDeactivate"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/","text":"Class: ExtensionStore # Common . Store .ExtensionStore Type parameters # Name Type T extends object Hierarchy # BaseStore < T > \u21b3 ExtensionStore Table of contents # Constructors # constructor Properties # displayName extension params Methods # cwd fromStore load loadExtension toJSON createInstance getInstance resetInstance Constructors # constructor # \u2022 new ExtensionStore < T >( \u00abdestructured\u00bb ) Type parameters # Name Type T extends object Parameters # Name Type \u00abdestructured\u00bb ExtensionStoreParams < T > Overrides # BaseStore.constructor Properties # displayName # \u2022 Readonly displayName : string Inherited from # BaseStore.displayName extension # \u2022 Protected Optional extension : LensExtension < LensExtensionDependencies > params # \u2022 Protected Readonly params : BaseStoreParams < T > Inherited from # BaseStore.params Methods # cwd # \u25b8 Protected cwd (): string Returns # string Overrides # BaseStore.cwd fromStore # \u25b8 Protected Abstract fromStore ( data ): void fromStore is called internally when a child class syncs with the file system. Note: This function must be synchronous. Parameters # Name Type Description data T the parsed information read from the stored JSON file Returns # void Inherited from # BaseStore.fromStore load # \u25b8 load (): void Returns # void Overrides # BaseStore.load loadExtension # \u25b8 loadExtension ( extension ): void Parameters # Name Type extension LensExtension < LensExtensionDependencies > Returns # void toJSON # \u25b8 Abstract 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. Returns # T Inherited from # BaseStore.toJSON createInstance # \u25b8 Static createInstance < T , R >( this , ...args ): T Deprecated This is a form of global shared state. Just call new Store(...) Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > ...args R Returns # T getInstance # \u25b8 Static getInstance < T , R >( this , strict? ): T Deprecated This is a form of global shared state. Just call new Store(...) Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > strict? true Returns # T \u25b8 Static getInstance < T , R >( this , strict ): undefined | T Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > strict false Returns # undefined | T resetInstance # \u25b8 Static resetInstance (): void Deprecated This is a form of global shared state. Just call new Store(...) Returns # void","title":"Class: ExtensionStore"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#class-extensionstoret","text":"Common . Store .ExtensionStore","title":"Class: ExtensionStore<T>"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#type-parameters","text":"Name Type T extends object","title":"Type parameters"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#hierarchy","text":"BaseStore < T > \u21b3 ExtensionStore","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#properties","text":"displayName extension params","title":"Properties"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#methods","text":"cwd fromStore load loadExtension toJSON createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructor","text":"\u2022 new ExtensionStore < T >( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#displayname","text":"\u2022 Readonly displayName : string","title":"displayName"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#extension","text":"\u2022 Protected Optional extension : LensExtension < LensExtensionDependencies >","title":"extension"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#params","text":"\u2022 Protected Readonly params : BaseStoreParams < T >","title":"params"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#cwd","text":"\u25b8 Protected cwd (): string","title":"cwd"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#fromstore","text":"\u25b8 Protected Abstract fromStore ( data ): void fromStore is called internally when a child class syncs with the file system. Note: This function must be synchronous.","title":"fromStore"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#load","text":"\u25b8 load (): void","title":"load"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#loadextension","text":"\u25b8 loadExtension ( extension ): void","title":"loadExtension"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#tojson","text":"\u25b8 Abstract 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.","title":"toJSON"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#createinstance","text":"\u25b8 Static createInstance < T , R >( this , ...args ): T Deprecated This is a form of global shared state. Just call new Store(...)","title":"createInstance"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#getinstance","text":"\u25b8 Static getInstance < T , R >( this , strict? ): T Deprecated This is a form of global shared state. Just call new Store(...)","title":"getInstance"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#resetinstance","text":"\u25b8 Static resetInstance (): void Deprecated This is a form of global shared state. Just call new Store(...)","title":"resetInstance"},{"location":"extensions/api/classes/Common.Util.Singleton/","text":"Class: Singleton # Common . Util .Singleton Deprecated This is a form of global shared state Table of contents # Constructors # constructor Methods # createInstance getInstance resetInstance Constructors # constructor # \u2022 new Singleton () Methods # createInstance # \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. Type parameters # Name Type T extends Singleton < T > R extends any [] Parameters # Name Type Description this StaticThis < T , R > Implicit argument that is the child class type ...args R The constructor arguments for the child class Returns # T An instance of the child class getInstance # \u25b8 Static getInstance < T , R >( this , strict? ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R extends any [] Parameters # 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 Returns # T An instance of the child class \u25b8 Static getInstance < T , R >( this , strict ): undefined | T Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > strict false Returns # undefined | T resetInstance # \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. Returns # void","title":"Class: Singleton"},{"location":"extensions/api/classes/Common.Util.Singleton/#class-singleton","text":"Common . Util .Singleton Deprecated This is a form of global shared state","title":"Class: Singleton"},{"location":"extensions/api/classes/Common.Util.Singleton/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Util.Singleton/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Util.Singleton/#methods","text":"createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/Common.Util.Singleton/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Util.Singleton/#constructor","text":"\u2022 new Singleton ()","title":"constructor"},{"location":"extensions/api/classes/Common.Util.Singleton/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Util.Singleton/#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.","title":"createInstance"},{"location":"extensions/api/classes/Common.Util.Singleton/#getinstance","text":"\u25b8 Static getInstance < T , R >( this , strict? ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/Common.Util.Singleton/#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.","title":"resetInstance"},{"location":"extensions/api/classes/Main.Ipc/","text":"Class: Ipc # Main .Ipc Hierarchy # IpcRegistrar \u21b3 Ipc Table of contents # Constructors # constructor Properties # [IpcPrefix] extension Methods # broadcast handle listen createInstance getInstance resetInstance Constructors # constructor # \u2022 new Ipc ( extension ) Parameters # Name Type extension LensExtension Overrides # IpcRegistrar.constructor Properties # [IpcPrefix] # \u2022 Readonly [IpcPrefix] : string Inherited from # IpcRegistrar.__@IpcPrefix@1575 extension # \u2022 Protected Readonly extension : LensExtension < LensExtensionDependencies > Inherited from # IpcRegistrar.extension Methods # broadcast # \u25b8 broadcast ( channel , ...args ): void Parameters # Name Type Description channel string The channel to broadcast to your whole extension, both main and renderer ...args any [] The arguments passed to all listeners Returns # void Inherited from # IpcRegistrar.broadcast handle # \u25b8 handle ( channel , handler ): void Declare a RPC over channel . Lens will cleanup when the extension is disabled or uninstalled Parameters # Name Type Description channel string The name of the RPC handler ( event : IpcMainInvokeEvent , ... args : any []) => any The remote procedure that is called Returns # void listen # \u25b8 listen ( channel , listener ): Disposer Listen for broadcasts within your extension Parameters # Name Type Description 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 Returns # Disposer An optional disposer, Lens will cleanup when the extension is disabled or uninstalled even if this is not called createInstance # \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. Type parameters # Name Type T extends Singleton < T > R extends any [] Parameters # Name Type Description this StaticThis < T , R > Implicit argument that is the child class type ...args R The constructor arguments for the child class Returns # T An instance of the child class Inherited from # IpcRegistrar.createInstance getInstance # \u25b8 Static getInstance < T , R >( this , strict? ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R extends any [] Parameters # 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 Returns # T An instance of the child class Inherited from # IpcRegistrar.getInstance \u25b8 Static getInstance < T , R >( this , strict ): undefined | T Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > strict false Returns # undefined | T Inherited from # IpcRegistrar.getInstance resetInstance # \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. Returns # void Inherited from # IpcRegistrar.resetInstance","title":"Class: Ipc"},{"location":"extensions/api/classes/Main.Ipc/#class-ipc","text":"Main .Ipc","title":"Class: Ipc"},{"location":"extensions/api/classes/Main.Ipc/#hierarchy","text":"IpcRegistrar \u21b3 Ipc","title":"Hierarchy"},{"location":"extensions/api/classes/Main.Ipc/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.Ipc/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.Ipc/#properties","text":"[IpcPrefix] extension","title":"Properties"},{"location":"extensions/api/classes/Main.Ipc/#methods","text":"broadcast handle listen createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/Main.Ipc/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.Ipc/#constructor","text":"\u2022 new Ipc ( extension )","title":"constructor"},{"location":"extensions/api/classes/Main.Ipc/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.Ipc/#ipcprefix","text":"\u2022 Readonly [IpcPrefix] : string","title":"[IpcPrefix]"},{"location":"extensions/api/classes/Main.Ipc/#extension","text":"\u2022 Protected Readonly extension : LensExtension < LensExtensionDependencies >","title":"extension"},{"location":"extensions/api/classes/Main.Ipc/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.Ipc/#broadcast","text":"\u25b8 broadcast ( channel , ...args ): void","title":"broadcast"},{"location":"extensions/api/classes/Main.Ipc/#handle","text":"\u25b8 handle ( channel , handler ): void Declare a RPC over channel . Lens will cleanup when the extension is disabled or uninstalled","title":"handle"},{"location":"extensions/api/classes/Main.Ipc/#listen","text":"\u25b8 listen ( channel , listener ): Disposer Listen for broadcasts within your extension","title":"listen"},{"location":"extensions/api/classes/Main.Ipc/#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.","title":"createInstance"},{"location":"extensions/api/classes/Main.Ipc/#getinstance","text":"\u25b8 Static getInstance < T , R >( this , strict? ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/Main.Ipc/#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.","title":"resetInstance"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/","text":"Class: ClusterRole # Main . K8sApi .ClusterRole Hierarchy # KubeObject < ClusterScopedMetadata , void , void > \u21b3 ClusterRole Table of contents # Constructors # constructor Properties # aggregationRule apiVersion kind metadata rules spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ClusterRole ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb ClusterRoleData Overrides # KubeObject . constructor Properties # aggregationRule # \u2022 Optional aggregationRule : AggregationRule apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata rules # \u2022 Optional rules : PolicyRule [] spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRules # \u25b8 getRules (): PolicyRule [] Returns # PolicyRule [] getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < ClusterRole > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ClusterRole"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#class-clusterrole","text":"Main . K8sApi .ClusterRole","title":"Class: ClusterRole"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#hierarchy","text":"KubeObject < ClusterScopedMetadata , void , void > \u21b3 ClusterRole","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#properties","text":"aggregationRule apiVersion kind metadata rules spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#constructor","text":"\u2022 new ClusterRole ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#aggregationrule","text":"\u2022 Optional aggregationRule : AggregationRule","title":"aggregationRule"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#rules","text":"\u2022 Optional rules : PolicyRule []","title":"rules"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getrules","text":"\u25b8 getRules (): PolicyRule []","title":"getRules"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRole/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/","text":"Class: ClusterRoleBinding # Main . K8sApi .ClusterRoleBinding Hierarchy # KubeObject < ClusterScopedMetadata , void , void > \u21b3 ClusterRoleBinding Table of contents # Constructors # constructor Properties # apiVersion kind metadata roleRef spec status subjects apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSubjectNames getSubjects getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ClusterRoleBinding ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb ClusterRoleBindingData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata roleRef # \u2022 roleRef : RoleRef spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status subjects # \u2022 Optional subjects : Subject [] apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getSubjectNames # \u25b8 getSubjectNames (): string Returns # string getSubjects # \u25b8 getSubjects (): Subject [] Returns # Subject [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < ClusterRoleBinding > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ClusterRoleBinding"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#class-clusterrolebinding","text":"Main . K8sApi .ClusterRoleBinding","title":"Class: ClusterRoleBinding"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#hierarchy","text":"KubeObject < ClusterScopedMetadata , void , void > \u21b3 ClusterRoleBinding","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#properties","text":"apiVersion kind metadata roleRef spec status subjects apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSubjectNames getSubjects getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#constructor","text":"\u2022 new ClusterRoleBinding ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#roleref","text":"\u2022 roleRef : RoleRef","title":"roleRef"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#subjects","text":"\u2022 Optional subjects : Subject []","title":"subjects"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getsubjectnames","text":"\u25b8 getSubjectNames (): string","title":"getSubjectNames"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#getsubjects","text":"\u25b8 getSubjects (): Subject []","title":"getSubjects"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ClusterRoleBinding/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/","text":"Class: ConfigMap # Main . K8sApi .ConfigMap Hierarchy # KubeObject < NamespaceScopedMetadata , void , void > \u21b3 ConfigMap Table of contents # Constructors # constructor Properties # apiVersion binaryData data immutable kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ConfigMap ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb ConfigMapData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion binaryData # \u2022 binaryData : Partial < Record < string , string >> data # \u2022 data : Partial < Record < string , string >> immutable # \u2022 Optional immutable : boolean kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getKeys # \u25b8 getKeys (): string [] Returns # string [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < ConfigMap > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ConfigMap"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#class-configmap","text":"Main . K8sApi .ConfigMap","title":"Class: ConfigMap"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , void > \u21b3 ConfigMap","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#properties","text":"apiVersion binaryData data immutable kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#constructor","text":"\u2022 new ConfigMap ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#binarydata","text":"\u2022 binaryData : Partial < Record < string , string >>","title":"binaryData"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#data","text":"\u2022 data : Partial < Record < string , string >>","title":"data"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#immutable","text":"\u2022 Optional immutable : boolean","title":"immutable"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getkeys","text":"\u25b8 getKeys (): string []","title":"getKeys"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ConfigMap/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/","text":"Class: CronJob # Main . K8sApi .CronJob Hierarchy # KubeObject < NamespaceScopedMetadata , CronJobStatus , CronJobSpec > \u21b3 CronJob Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getLastScheduleTime getName getNs getOwnerRefs getResourceVersion getSchedule getScopedName getSearchFields getSuspendFlag getTimeDiffFromNow isNeverRun isSuspend patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new CronJob ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , CronJobStatus , CronJobSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : CronJobSpec Inherited from # KubeObject . spec status # \u2022 Optional status : CronJobStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/batch/v1/cronjobs\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"CronJob\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLastScheduleTime # \u25b8 getLastScheduleTime (): string Returns # string getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSchedule # \u25b8 getSchedule (): string Returns # string getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSuspendFlag # \u25b8 getSuspendFlag (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow isNeverRun # \u25b8 isNeverRun (): boolean Returns # boolean isSuspend # \u25b8 isSuspend (): undefined | boolean Returns # undefined | boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < CronJob > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: CronJob"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#class-cronjob","text":"Main . K8sApi .CronJob","title":"Class: CronJob"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , CronJobStatus , CronJobSpec > \u21b3 CronJob","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getLastScheduleTime getName getNs getOwnerRefs getResourceVersion getSchedule getScopedName getSearchFields getSuspendFlag getTimeDiffFromNow isNeverRun isSuspend patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#constructor","text":"\u2022 new CronJob ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#spec","text":"\u2022 spec : CronJobSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#status","text":"\u2022 Optional status : CronJobStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/batch/v1/cronjobs\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#kind_1","text":"\u25aa Static Readonly kind : \"CronJob\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getlastscheduletime","text":"\u25b8 getLastScheduleTime (): string","title":"getLastScheduleTime"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getschedule","text":"\u25b8 getSchedule (): string","title":"getSchedule"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#getsuspendflag","text":"\u25b8 getSuspendFlag (): string","title":"getSuspendFlag"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isneverrun","text":"\u25b8 isNeverRun (): boolean","title":"isNeverRun"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#issuspend","text":"\u25b8 isSuspend (): undefined | boolean","title":"isSuspend"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.CronJob/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/","text":"Class: CustomResourceDefinition # Main . K8sApi .CustomResourceDefinition Hierarchy # KubeObject < ClusterScopedMetadata , CustomResourceDefinitionStatus , CustomResourceDefinitionSpec > \u21b3 CustomResourceDefinition Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getConditions getConversion getCreationTimestamp getFinalizers getGroup getId getLabels getName getNames getNs getOwnerRefs getPluralName getPreferedVersion getPrinterColumns getResourceApiBase getResourceKind getResourceTitle getResourceUrl getResourceVersion getScope getScopedName getSearchFields getStoredVersions getTimeDiffFromNow getValidation getVersion isNamespaced patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new CustomResourceDefinition ( data ) Parameters # Name Type data KubeJsonApiData < ClusterScopedMetadata , CustomResourceDefinitionStatus , CustomResourceDefinitionSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : CustomResourceDefinitionSpec Inherited from # KubeObject . spec status # \u2022 Optional status : CustomResourceDefinitionStatus Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getConditions # \u25b8 getConditions (): { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] Returns # { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] getConversion # \u25b8 getConversion (): string Returns # string getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getGroup # \u25b8 getGroup (): string Returns # string getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNames # \u25b8 getNames (): CustomResourceDefinitionNames Returns # CustomResourceDefinitionNames getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPluralName # \u25b8 getPluralName (): string Returns # string getPreferedVersion # \u25b8 getPreferedVersion (): CustomResourceDefinitionVersion Returns # CustomResourceDefinitionVersion getPrinterColumns # \u25b8 getPrinterColumns ( ignorePriority? ): AdditionalPrinterColumnsV1 [] Parameters # Name Type ignorePriority? boolean Returns # AdditionalPrinterColumnsV1 [] getResourceApiBase # \u25b8 getResourceApiBase (): string Returns # string getResourceKind # \u25b8 getResourceKind (): string Returns # string getResourceTitle # \u25b8 getResourceTitle (): string Returns # string getResourceUrl # \u25b8 getResourceUrl (): string Returns # string getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScope # \u25b8 getScope (): \"Cluster\" | \"Namespaced\" Returns # \"Cluster\" | \"Namespaced\" getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getStoredVersions # \u25b8 getStoredVersions (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getValidation # \u25b8 getValidation (): string Returns # string getVersion # \u25b8 getVersion (): string Returns # string isNamespaced # \u25b8 isNamespaced (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < CustomResourceDefinition > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: CustomResourceDefinition"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#class-customresourcedefinition","text":"Main . K8sApi .CustomResourceDefinition","title":"Class: CustomResourceDefinition"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#hierarchy","text":"KubeObject < ClusterScopedMetadata , CustomResourceDefinitionStatus , CustomResourceDefinitionSpec > \u21b3 CustomResourceDefinition","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#methods","text":"delete getAge getAnnotations getConditions getConversion getCreationTimestamp getFinalizers getGroup getId getLabels getName getNames getNs getOwnerRefs getPluralName getPreferedVersion getPrinterColumns getResourceApiBase getResourceKind getResourceTitle getResourceUrl getResourceVersion getScope getScopedName getSearchFields getStoredVersions getTimeDiffFromNow getValidation getVersion isNamespaced patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#constructor","text":"\u2022 new CustomResourceDefinition ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#spec","text":"\u2022 spec : CustomResourceDefinitionSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#status","text":"\u2022 Optional status : CustomResourceDefinitionStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getconditions","text":"\u25b8 getConditions (): { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[]","title":"getConditions"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getconversion","text":"\u25b8 getConversion (): string","title":"getConversion"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getgroup","text":"\u25b8 getGroup (): string","title":"getGroup"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getnames","text":"\u25b8 getNames (): CustomResourceDefinitionNames","title":"getNames"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getpluralname","text":"\u25b8 getPluralName (): string","title":"getPluralName"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getpreferedversion","text":"\u25b8 getPreferedVersion (): CustomResourceDefinitionVersion","title":"getPreferedVersion"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getprintercolumns","text":"\u25b8 getPrinterColumns ( ignorePriority? ): AdditionalPrinterColumnsV1 []","title":"getPrinterColumns"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourceapibase","text":"\u25b8 getResourceApiBase (): string","title":"getResourceApiBase"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourcekind","text":"\u25b8 getResourceKind (): string","title":"getResourceKind"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourcetitle","text":"\u25b8 getResourceTitle (): string","title":"getResourceTitle"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourceurl","text":"\u25b8 getResourceUrl (): string","title":"getResourceUrl"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getscope","text":"\u25b8 getScope (): \"Cluster\" | \"Namespaced\"","title":"getScope"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getstoredversions","text":"\u25b8 getStoredVersions (): string","title":"getStoredVersions"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getvalidation","text":"\u25b8 getValidation (): string","title":"getValidation"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#getversion","text":"\u25b8 getVersion (): string","title":"getVersion"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isnamespaced","text":"\u25b8 isNamespaced (): boolean","title":"isNamespaced"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.CustomResourceDefinition/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/","text":"Class: DaemonSet # Main . K8sApi .DaemonSet Hierarchy # KubeObject < NamespaceScopedMetadata , DaemonSetStatus , DaemonSetSpec > \u21b3 DaemonSet Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getCreationTimestamp getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new DaemonSet ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , DaemonSetStatus , DaemonSetSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : DaemonSetSpec Inherited from # KubeObject . spec status # \u2022 Optional status : DaemonSetStatus Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAffinity # \u25b8 getAffinity (): undefined | Affinity Returns # undefined | Affinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getImages # \u25b8 getImages (): ( undefined | string )[] Returns # ( undefined | string )[] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): Toleration [] Returns # Toleration [] patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < DaemonSet > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: DaemonSet"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#class-daemonset","text":"Main . K8sApi .DaemonSet","title":"Class: DaemonSet"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , DaemonSetStatus , DaemonSetSpec > \u21b3 DaemonSet","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getCreationTimestamp getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#constructor","text":"\u2022 new DaemonSet ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#spec","text":"\u2022 spec : DaemonSetSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#status","text":"\u2022 Optional status : DaemonSetStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getaffinity","text":"\u25b8 getAffinity (): undefined | Affinity","title":"getAffinity"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getimages","text":"\u25b8 getImages (): ( undefined | string )[]","title":"getImages"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#gettolerations","text":"\u25b8 getTolerations (): Toleration []","title":"getTolerations"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.DaemonSet/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/","text":"Class: Deployment # Main . K8sApi .Deployment Hierarchy # KubeObject < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec > \u21b3 Deployment Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getConditions getConditionsText getCreationTimestamp getFinalizers getId getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Deployment ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : DeploymentSpec Inherited from # KubeObject . spec status # \u2022 Optional status : DeploymentStatus Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAffinity # \u25b8 getAffinity (): undefined | Affinity Returns # undefined | Affinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getConditions # \u25b8 getConditions ( activeOnly? ): BaseKubeObjectCondition [] Parameters # Name Type activeOnly? boolean Returns # BaseKubeObjectCondition [] getConditionsText # \u25b8 getConditionsText ( activeOnly? ): string Parameters # Name Type activeOnly? boolean Returns # string getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getReplicas # \u25b8 getReplicas (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): Toleration [] Returns # Toleration [] patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Deployment > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Deployment"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#class-deployment","text":"Main . K8sApi .Deployment","title":"Class: Deployment"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec > \u21b3 Deployment","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getConditions getConditionsText getCreationTimestamp getFinalizers getId getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#constructor","text":"\u2022 new Deployment ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#spec","text":"\u2022 spec : DeploymentSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#status","text":"\u2022 Optional status : DeploymentStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getaffinity","text":"\u25b8 getAffinity (): undefined | Affinity","title":"getAffinity"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getconditions","text":"\u25b8 getConditions ( activeOnly? ): BaseKubeObjectCondition []","title":"getConditions"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getconditionstext","text":"\u25b8 getConditionsText ( activeOnly? ): string","title":"getConditionsText"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getreplicas","text":"\u25b8 getReplicas (): number","title":"getReplicas"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#gettolerations","text":"\u25b8 getTolerations (): Toleration []","title":"getTolerations"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Deployment/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/","text":"Class: Endpoint # Main . K8sApi .Endpoint Hierarchy # KubeObject < NamespaceScopedMetadata , void , void > \u21b3 Endpoint Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status subsets apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getEndpointSubsets getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject toString update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Endpoint ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb EndpointsData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status subsets # \u2022 Optional subsets : EndpointSubset [] apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getEndpointSubsets # \u25b8 getEndpointSubsets (): Required < EndpointSubset >[] Returns # Required < EndpointSubset >[] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject toString # \u25b8 toString (): string Returns # string update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Endpoint > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Endpoint"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#class-endpoint","text":"Main . K8sApi .Endpoint","title":"Class: Endpoint"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , void > \u21b3 Endpoint","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#properties","text":"apiVersion kind metadata spec status subsets apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#methods","text":"delete getAge getAnnotations getCreationTimestamp getEndpointSubsets getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject toString update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#constructor","text":"\u2022 new Endpoint ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#subsets","text":"\u2022 Optional subsets : EndpointSubset []","title":"subsets"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getendpointsubsets","text":"\u25b8 getEndpointSubsets (): Required < EndpointSubset >[]","title":"getEndpointSubsets"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#tostring","text":"\u25b8 toString (): string","title":"toString"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Endpoint/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/","text":"Class: HorizontalPodAutoscaler # Main . K8sApi .HorizontalPodAutoscaler Hierarchy # KubeObject < NamespaceScopedMetadata , HorizontalPodAutoscalerStatus , HorizontalPodAutoscalerSpec > \u21b3 HorizontalPodAutoscaler Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getConditions getCreationTimestamp getCurrentMetrics getFinalizers getId getLabels getMaxPods getMetrics getMinPods getName getNs getOwnerRefs getReadyConditions getReplicas getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new HorizontalPodAutoscaler ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , HorizontalPodAutoscalerStatus , HorizontalPodAutoscalerSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : HorizontalPodAutoscalerSpec Inherited from # KubeObject . spec status # \u2022 Optional status : HorizontalPodAutoscalerStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/autoscaling/v2/horizontalpodautoscalers\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"HorizontalPodAutoscaler\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getConditions # \u25b8 getConditions (): { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] Returns # { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getCurrentMetrics # \u25b8 getCurrentMetrics (): HorizontalPodAutoscalerMetricStatus [] Returns # HorizontalPodAutoscalerMetricStatus [] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMaxPods # \u25b8 getMaxPods (): number Returns # number getMetrics # \u25b8 getMetrics (): HorizontalPodAutoscalerMetricSpec [] Returns # HorizontalPodAutoscalerMetricSpec [] getMinPods # \u25b8 getMinPods (): number Returns # number getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getReadyConditions # \u25b8 getReadyConditions (): { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] Returns # { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] getReplicas # \u25b8 getReplicas (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < HorizontalPodAutoscaler > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#class-horizontalpodautoscaler","text":"Main . K8sApi .HorizontalPodAutoscaler","title":"Class: HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , HorizontalPodAutoscalerStatus , HorizontalPodAutoscalerSpec > \u21b3 HorizontalPodAutoscaler","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#methods","text":"delete getAge getAnnotations getConditions getCreationTimestamp getCurrentMetrics getFinalizers getId getLabels getMaxPods getMetrics getMinPods getName getNs getOwnerRefs getReadyConditions getReplicas getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#constructor","text":"\u2022 new HorizontalPodAutoscaler ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#spec","text":"\u2022 spec : HorizontalPodAutoscalerSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#status","text":"\u2022 Optional status : HorizontalPodAutoscalerStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/autoscaling/v2/horizontalpodautoscalers\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#kind_1","text":"\u25aa Static Readonly kind : \"HorizontalPodAutoscaler\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getconditions","text":"\u25b8 getConditions (): { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[]","title":"getConditions"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getcurrentmetrics","text":"\u25b8 getCurrentMetrics (): HorizontalPodAutoscalerMetricStatus []","title":"getCurrentMetrics"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getmaxpods","text":"\u25b8 getMaxPods (): number","title":"getMaxPods"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getmetrics","text":"\u25b8 getMetrics (): HorizontalPodAutoscalerMetricSpec []","title":"getMetrics"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getminpods","text":"\u25b8 getMinPods (): number","title":"getMinPods"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getreadyconditions","text":"\u25b8 getReadyConditions (): { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[]","title":"getReadyConditions"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getreplicas","text":"\u25b8 getReplicas (): number","title":"getReplicas"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.HorizontalPodAutoscaler/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/","text":"Class: Ingress # Main . K8sApi .Ingress Hierarchy # KubeObject < NamespaceScopedMetadata , IngressStatus , IngressSpec > \u21b3 Ingress Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getHosts getId getLabels getLoadBalancers getName getNs getOwnerRefs getPorts getResourceVersion getRoutes getRules getScopedName getSearchFields getServiceNamePort getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Ingress ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , IngressStatus , IngressSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : IngressSpec Inherited from # KubeObject . spec status # \u2022 Optional status : IngressStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/networking.k8s.io/v1/ingresses\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Ingress\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getHosts # \u25b8 getHosts (): string [] Returns # string [] getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLoadBalancers # \u25b8 getLoadBalancers (): ( undefined | string )[] Returns # ( undefined | string )[] getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPorts # \u25b8 getPorts (): string Returns # string getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRoutes # \u25b8 getRoutes (): string [] Returns # string [] getRules # \u25b8 getRules (): IngressRule [] Returns # IngressRule [] getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getServiceNamePort # \u25b8 getServiceNamePort (): undefined | ExtensionsBackend Returns # undefined | ExtensionsBackend getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Ingress > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Ingress"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#class-ingress","text":"Main . K8sApi .Ingress","title":"Class: Ingress"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , IngressStatus , IngressSpec > \u21b3 Ingress","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getHosts getId getLabels getLoadBalancers getName getNs getOwnerRefs getPorts getResourceVersion getRoutes getRules getScopedName getSearchFields getServiceNamePort getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#constructor","text":"\u2022 new Ingress ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#spec","text":"\u2022 spec : IngressSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#status","text":"\u2022 Optional status : IngressStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/networking.k8s.io/v1/ingresses\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#kind_1","text":"\u25aa Static Readonly kind : \"Ingress\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#gethosts","text":"\u25b8 getHosts (): string []","title":"getHosts"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getloadbalancers","text":"\u25b8 getLoadBalancers (): ( undefined | string )[]","title":"getLoadBalancers"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getports","text":"\u25b8 getPorts (): string","title":"getPorts"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getroutes","text":"\u25b8 getRoutes (): string []","title":"getRoutes"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getrules","text":"\u25b8 getRules (): IngressRule []","title":"getRules"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#getservicenameport","text":"\u25b8 getServiceNamePort (): undefined | ExtensionsBackend","title":"getServiceNamePort"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Ingress/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Job/","text":"Class: Job # Main . K8sApi .Job Hierarchy # KubeObject < NamespaceScopedMetadata , JobStatus , JobSpec > \u21b3 Job Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getCompletions getCondition getCreationTimestamp getDesiredCompletions getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getParallelism getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Job ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , JobStatus , JobSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : JobSpec Inherited from # KubeObject . spec status # \u2022 Optional status : JobStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/batch/v1/jobs\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Job\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAffinity # \u25b8 getAffinity (): undefined | Affinity Returns # undefined | Affinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCompletions # \u25b8 getCompletions (): number Returns # number getCondition # \u25b8 getCondition (): undefined | BaseKubeObjectCondition Returns # undefined | BaseKubeObjectCondition getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getDesiredCompletions # \u25b8 getDesiredCompletions (): number Returns # number getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getImages # \u25b8 getImages (): ( undefined | string )[] Returns # ( undefined | string )[] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getParallelism # \u25b8 getParallelism (): undefined | number Returns # undefined | number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): Toleration [] Returns # Toleration [] patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Job > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Job"},{"location":"extensions/api/classes/Main.K8sApi.Job/#class-job","text":"Main . K8sApi .Job","title":"Class: Job"},{"location":"extensions/api/classes/Main.K8sApi.Job/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , JobStatus , JobSpec > \u21b3 Job","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Job/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Job/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Job/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Job/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Job/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getCompletions getCondition getCreationTimestamp getDesiredCompletions getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getParallelism getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Job/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Job/#constructor","text":"\u2022 new Job ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Job/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Job/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Job/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Job/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Job/#spec","text":"\u2022 spec : JobSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Job/#status","text":"\u2022 Optional status : JobStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Job/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/batch/v1/jobs\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Job/#kind_1","text":"\u25aa Static Readonly kind : \"Job\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Job/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Job/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Job/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Job/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Job/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getaffinity","text":"\u25b8 getAffinity (): undefined | Affinity","title":"getAffinity"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/Main.K8sApi.Job/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getcompletions","text":"\u25b8 getCompletions (): number","title":"getCompletions"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getcondition","text":"\u25b8 getCondition (): undefined | BaseKubeObjectCondition","title":"getCondition"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getdesiredcompletions","text":"\u25b8 getDesiredCompletions (): number","title":"getDesiredCompletions"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getimages","text":"\u25b8 getImages (): ( undefined | string )[]","title":"getImages"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getparallelism","text":"\u25b8 getParallelism (): undefined | number","title":"getParallelism"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Job/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/Main.K8sApi.Job/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/Main.K8sApi.Job/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Job/#gettolerations","text":"\u25b8 getTolerations (): Toleration []","title":"getTolerations"},{"location":"extensions/api/classes/Main.K8sApi.Job/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Job/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Job/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Job/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Job/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Job/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Job/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Job/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Job/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Job/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Job/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Job/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/","text":"Class: KubeEvent # Main . K8sApi .KubeEvent Hierarchy # KubeObject < KubeObjectMetadata < KubeObjectScope.Namespace >, void , void > \u21b3 KubeEvent Table of contents # Constructors # constructor Properties # action apiVersion count eventTime firstTimestamp involvedObject kind lastTimestamp message metadata reason related reportingComponent reportingInstance series source spec status type apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getFirstSeenTime getId getLabels getLastSeenTime getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSource getTimeDiffFromNow isWarning patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new KubeEvent ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb KubeEventData Overrides # KubeObject . constructor Properties # action # \u2022 Optional action : string apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion count # \u2022 Optional count : number eventTime # \u2022 Optional eventTime : string firstTimestamp # \u2022 Optional firstTimestamp : string involvedObject # \u2022 involvedObject : Required < ObjectReference > kind # \u2022 kind : string Inherited from # KubeObject . kind lastTimestamp # \u2022 Optional lastTimestamp : string message # \u2022 Optional message : string metadata # \u2022 metadata : KubeObjectMetadata < Namespace > Inherited from # KubeObject . metadata reason # \u2022 Optional reason : string related # \u2022 Optional related : ObjectReference reportingComponent # \u2022 Optional reportingComponent : string reportingInstance # \u2022 Optional reportingInstance : string series # \u2022 Optional series : EventSeries source # \u2022 Optional source : EventSource spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status type # \u2022 Optional type : string Current supported values are: - \"Normal\" - \"Warning\" apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getFirstSeenTime # \u25b8 getFirstSeenTime (): string Deprecated This function is not reactive to changing of time. If rendering use instead Returns # string getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLastSeenTime # \u25b8 getLastSeenTime (): string Deprecated This function is not reactive to changing of time. If rendering use instead Returns # string getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSource # \u25b8 getSource (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow isWarning # \u25b8 isWarning (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < KubeEvent > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: KubeEvent"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#class-kubeevent","text":"Main . K8sApi .KubeEvent","title":"Class: KubeEvent"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#hierarchy","text":"KubeObject < KubeObjectMetadata < KubeObjectScope.Namespace >, void , void > \u21b3 KubeEvent","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#properties","text":"action apiVersion count eventTime firstTimestamp involvedObject kind lastTimestamp message metadata reason related reportingComponent reportingInstance series source spec status type apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getFirstSeenTime getId getLabels getLastSeenTime getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSource getTimeDiffFromNow isWarning patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#constructor","text":"\u2022 new KubeEvent ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#action","text":"\u2022 Optional action : string","title":"action"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#count","text":"\u2022 Optional count : number","title":"count"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#eventtime","text":"\u2022 Optional eventTime : string","title":"eventTime"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#firsttimestamp","text":"\u2022 Optional firstTimestamp : string","title":"firstTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#involvedobject","text":"\u2022 involvedObject : Required < ObjectReference >","title":"involvedObject"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#lasttimestamp","text":"\u2022 Optional lastTimestamp : string","title":"lastTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#message","text":"\u2022 Optional message : string","title":"message"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#metadata","text":"\u2022 metadata : KubeObjectMetadata < Namespace >","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#reason","text":"\u2022 Optional reason : string","title":"reason"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#related","text":"\u2022 Optional related : ObjectReference","title":"related"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#reportingcomponent","text":"\u2022 Optional reportingComponent : string","title":"reportingComponent"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#reportinginstance","text":"\u2022 Optional reportingInstance : string","title":"reportingInstance"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#series","text":"\u2022 Optional series : EventSeries","title":"series"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#source","text":"\u2022 Optional source : EventSource","title":"source"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#type","text":"\u2022 Optional type : string Current supported values are: - \"Normal\" - \"Warning\"","title":"type"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getfirstseentime","text":"\u25b8 getFirstSeenTime (): string Deprecated This function is not reactive to changing of time. If rendering use instead","title":"getFirstSeenTime"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getlastseentime","text":"\u25b8 getLastSeenTime (): string Deprecated This function is not reactive to changing of time. If rendering use instead","title":"getLastSeenTime"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#getsource","text":"\u25b8 getSource (): string","title":"getSource"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#iswarning","text":"\u25b8 isWarning (): boolean","title":"isWarning"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeEvent/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/","text":"Class: KubeObject # Main . K8sApi .KubeObject Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Hierarchy # 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 Implements # ItemObject Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new KubeObject < Metadata , Status , Spec >( data ) Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Properties # apiVersion # \u2022 apiVersion : string kind # \u2022 kind : string metadata # \u2022 metadata : Metadata spec # \u2022 spec : Spec status # \u2022 Optional status : Status apiBase # \u25aa Static Optional Readonly apiBase : string kind # \u25aa Static Optional Readonly kind : string namespaced # \u25aa Static Optional Readonly namespaced : boolean Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] getId # \u25b8 getId (): string Returns # string Implementation of # ItemObject.getId getLabels # \u25b8 getLabels (): string [] Returns # string [] getName # \u25b8 getName (): string Returns # string Implementation of # ItemObject.getName getNs # \u25b8 getNs (): Metadata [ \"namespace\" ] Returns # Metadata [ \"namespace\" ] getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : Metadata [ \"namespace\" ] ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : Metadata [ \"namespace\" ] ; uid : string }[] getResourceVersion # \u25b8 getResourceVersion (): string Returns # string getScopedName # \u25b8 getScopedName (): string Returns # string getSearchFields # \u25b8 getSearchFields (): ( string | Metadata [ \"namespace\" ])[] Returns # ( string | Metadata [ \"namespace\" ])[] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < KubeObject < Metadata , Status , Spec >> Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string []","title":"Class: KubeObject"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#class-kubeobjectmetadata-status-spec","text":"Main . K8sApi .KubeObject","title":"Class: KubeObject<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#type-parameters","text":"Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown","title":"Type parameters"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#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","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#implements","text":"ItemObject","title":"Implements"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#constructor","text":"\u2022 new KubeObject < Metadata , Status , Spec >( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#spec","text":"\u2022 spec : Spec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#status","text":"\u2022 Optional status : Status","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#apibase","text":"\u25aa Static Optional Readonly apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#kind_1","text":"\u25aa Static Optional Readonly kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#namespaced","text":"\u25aa Static Optional Readonly namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getns","text":"\u25b8 getNs (): Metadata [ \"namespace\" ]","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : Metadata [ \"namespace\" ] ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#getsearchfields","text":"\u25b8 getSearchFields (): ( string | Metadata [ \"namespace\" ])[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.KubeObject/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/","text":"Class: KubeObjectStore # Main . K8sApi .KubeObjectStore Type parameters # Name Type K extends KubeObject = KubeObject A extends InternalKubeApi < K , D > = InternalKubeApi < K , KubeJsonApiDataFor < K >> D extends KubeJsonApiDataFor < K > = KubeApiDataFrom < K , A > Hierarchy # KubeObjectStore < K , A , D > \u21b3 KubeObjectStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds context Accessors # context contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new KubeObjectStore < K , A , D >( api , opts? ) Type parameters # Name Type 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 > Parameters # Name Type api A opts? KubeObjectStoreOptions Overrides # InternalKubeObjectStore.constructor \u2022 new KubeObjectStore < K , A , D >() Deprecated Supply API instance through constructor Type parameters # Name Type 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 > Overrides # InternalKubeObjectStore.constructor Properties # api # \u2022 Readonly api : A Inherited from # InternalKubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # InternalKubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : K ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item K Returns # string Inherited from # InternalKubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # InternalKubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < D >> Inherited from # InternalKubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # InternalKubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # InternalKubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # InternalKubeObjectStore.isLoading items # \u2022 items : IObservableArray < K > Inherited from # InternalKubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # InternalKubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # InternalKubeObjectStore.selectedItemsIds context # \u25aa Static Readonly context : Object Deprecated This is no longer used and shouldn't have been every really used Type declaration # Name Type get () => ClusterContext set ( ctx : ClusterContext ) => void Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # InternalKubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # InternalKubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # InternalKubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < K , void , undefined > Returns # Generator < K , void , undefined > Inherited from # InternalKubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # InternalKubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string data? PartialDeep < K > Returns # Promise < K > Inherited from # InternalKubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | K > Parameters # Name Type params Object params.name string params.namespace? string data? PartialDeep < K > Returns # Promise < null | K > Inherited from # InternalKubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): K [] Parameters # Name Type items K [] Returns # K [] Inherited from # InternalKubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): K [] Parameters # Name Type namespace string | string [] strict? boolean Returns # K [] Inherited from # InternalKubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | K Parameters # Name Type id string Returns # undefined | K Inherited from # InternalKubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): K [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # K [] Inherited from # InternalKubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | K Parameters # Name Type name string namespace? string Returns # undefined | K Inherited from # InternalKubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | K Parameters # Name Type path string Returns # undefined | K Inherited from # InternalKubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # InternalKubeObjectStore.getIndexById getItems # \u25b8 getItems (): K [] Returns # K [] Inherited from # InternalKubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # InternalKubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item K Returns # boolean Inherited from # InternalKubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? K [] Returns # boolean Inherited from # InternalKubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < K > Inherited from # InternalKubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | K []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | K []> Inherited from # InternalKubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < K > Parameters # Name Type resourcePath string Returns # Promise < K > Inherited from # InternalKubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | K > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | K > Inherited from # InternalKubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < K []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < K []> Inherited from # InternalKubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): K [] Parameters # Name Type partialItems K [] \u00abdestructured\u00bb MergeItemsOptions Returns # K [] Inherited from # InternalKubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < K > Parameters # Name Type item K patch Patch Returns # Promise < K > Inherited from # InternalKubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): K [] Parameters # Name Type items K [] Returns # K [] Inherited from # InternalKubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | K []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | K []> Inherited from # InternalKubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item K Returns # Promise < void > Inherited from # InternalKubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item K request () => Promise < any > Returns # Promise < void > Inherited from # InternalKubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items K [] Returns # Promise < void > Inherited from # InternalKubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # InternalKubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # InternalKubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # InternalKubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # InternalKubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item K Returns # void Inherited from # InternalKubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # K [] Inherited from # InternalKubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # InternalKubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item K Returns # void Inherited from # InternalKubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? K [] Returns # void Inherited from # InternalKubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item K Returns # void Inherited from # InternalKubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < K > Parameters # Name Type item K data PartialDeep < K > Returns # Promise < K > Inherited from # InternalKubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # InternalKubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < K > Parameters # Name Type item K request () => Promise < K > Returns # Promise < K > Inherited from # InternalKubeObjectStore.updateItem","title":"Class: KubeObjectStore"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#class-kubeobjectstorek-a-d","text":"Main . K8sApi .KubeObjectStore","title":"Class: KubeObjectStore<K, A, D>"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#type-parameters","text":"Name Type K extends KubeObject = KubeObject A extends InternalKubeApi < K , D > = InternalKubeApi < K , KubeJsonApiDataFor < K >> D extends KubeJsonApiDataFor < K > = KubeApiDataFrom < K , A >","title":"Type parameters"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#hierarchy","text":"KubeObjectStore < K , A , D > \u21b3 KubeObjectStore","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds context","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#accessors","text":"context contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#constructor","text":"\u2022 new KubeObjectStore < K , A , D >( api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#api","text":"\u2022 Readonly api : A","title":"api"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : K ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < D >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#items","text":"\u2022 items : IObservableArray < K >","title":"items"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#context","text":"\u25aa Static Readonly context : Object Deprecated This is no longer used and shouldn't have been every really used","title":"context"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#context_1","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#iterator","text":"\u25b8 [iterator] (): Generator < K , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#create","text":"\u25b8 create ( params , data? ): Promise < K >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | K >","title":"createItem"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): K []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): K []","title":"getAllByNs"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbyid","text":"\u25b8 getById ( id ): undefined | K","title":"getById"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): K []","title":"getByLabel"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | K","title":"getByName"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | K","title":"getByPath"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#getitems","text":"\u25b8 getItems (): K []","title":"getItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#load","text":"\u25b8 load ( params ): Promise < K >","title":"load"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | K []>","title":"loadAll"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < K >","title":"loadFromPath"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | K >","title":"loadItem"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < K []>","title":"loadItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): K []","title":"mergeItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < K >","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): K []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | K []>","title":"reloadAll"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#update","text":"\u25b8 update ( item , data ): Promise < K >","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Main.K8sApi.KubeObjectStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < K >","title":"updateItem"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/","text":"Class: KubeStatus # Main . K8sApi .KubeStatus Table of contents # Constructors # constructor Properties # apiVersion code kind message reason Constructors # constructor # \u2022 new KubeStatus ( data ) Parameters # Name Type data KubeStatusData Properties # apiVersion # \u2022 Readonly apiVersion : string code # \u2022 Readonly code : number kind # \u2022 Readonly kind : \"Status\" message # \u2022 Readonly message : string reason # \u2022 Readonly reason : string","title":"Class: KubeStatus"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#class-kubestatus","text":"Main . K8sApi .KubeStatus","title":"Class: KubeStatus"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#properties","text":"apiVersion code kind message reason","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#constructor","text":"\u2022 new KubeStatus ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#apiversion","text":"\u2022 Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#code","text":"\u2022 Readonly code : number","title":"code"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#kind","text":"\u2022 Readonly kind : \"Status\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#message","text":"\u2022 Readonly message : string","title":"message"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#reason","text":"\u2022 Readonly reason : string","title":"reason"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/","text":"Class: LimitRange # Main . K8sApi .LimitRange Hierarchy # KubeObject < NamespaceScopedMetadata , void , LimitRangeSpec > \u21b3 LimitRange Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getContainerLimits getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getPVCLimits getPodLimits getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new LimitRange ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , void , LimitRangeSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : LimitRangeSpec Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/api/v1/limitranges\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"LimitRange\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getContainerLimits # \u25b8 getContainerLimits (): LimitRangeItem [] Returns # LimitRangeItem [] getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPVCLimits # \u25b8 getPVCLimits (): LimitRangeItem [] Returns # LimitRangeItem [] getPodLimits # \u25b8 getPodLimits (): LimitRangeItem [] Returns # LimitRangeItem [] getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < LimitRange > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: LimitRange"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#class-limitrange","text":"Main . K8sApi .LimitRange","title":"Class: LimitRange"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , LimitRangeSpec > \u21b3 LimitRange","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#methods","text":"delete getAge getAnnotations getContainerLimits getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getPVCLimits getPodLimits getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#constructor","text":"\u2022 new LimitRange ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#spec","text":"\u2022 spec : LimitRangeSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/limitranges\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#kind_1","text":"\u25aa Static Readonly kind : \"LimitRange\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getcontainerlimits","text":"\u25b8 getContainerLimits (): LimitRangeItem []","title":"getContainerLimits"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getpvclimits","text":"\u25b8 getPVCLimits (): LimitRangeItem []","title":"getPVCLimits"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getpodlimits","text":"\u25b8 getPodLimits (): LimitRangeItem []","title":"getPodLimits"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.LimitRange/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/","text":"Class: Namespace # Main . K8sApi .Namespace Hierarchy # KubeObject < ClusterScopedMetadata , NamespaceStatus , NamespaceSpec > \u21b3 Namespace Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getStatus getTimeDiffFromNow isChildOf isControlledByHNC isSubnamespace patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Namespace ( data ) Parameters # Name Type data KubeJsonApiData < ClusterScopedMetadata , NamespaceStatus , NamespaceSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : NamespaceSpec Inherited from # KubeObject . spec status # \u2022 Optional status : NamespaceStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/api/v1/namespaces\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Namespace\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : false Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getStatus # \u25b8 getStatus (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow isChildOf # \u25b8 isChildOf ( parentName ): undefined | string Parameters # Name Type parentName string Returns # undefined | string isControlledByHNC # \u25b8 isControlledByHNC (): undefined | string Returns # undefined | string isSubnamespace # \u25b8 isSubnamespace (): undefined | string Returns # undefined | string patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Namespace > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Namespace"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#class-namespace","text":"Main . K8sApi .Namespace","title":"Class: Namespace"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#hierarchy","text":"KubeObject < ClusterScopedMetadata , NamespaceStatus , NamespaceSpec > \u21b3 Namespace","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getStatus getTimeDiffFromNow isChildOf isControlledByHNC isSubnamespace patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#constructor","text":"\u2022 new Namespace ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#spec","text":"\u2022 spec : NamespaceSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#status","text":"\u2022 Optional status : NamespaceStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/namespaces\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#kind_1","text":"\u25aa Static Readonly kind : \"Namespace\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#namespaced","text":"\u25aa Static Readonly namespaced : false","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#getstatus","text":"\u25b8 getStatus (): string","title":"getStatus"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#ischildof","text":"\u25b8 isChildOf ( parentName ): undefined | string","title":"isChildOf"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#iscontrolledbyhnc","text":"\u25b8 isControlledByHNC (): undefined | string","title":"isControlledByHNC"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#issubnamespace","text":"\u25b8 isSubnamespace (): undefined | string","title":"isSubnamespace"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Namespace/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/","text":"Class: NetworkPolicy # Main . K8sApi .NetworkPolicy Hierarchy # KubeObject < NamespaceScopedMetadata , void , NetworkPolicySpec > \u21b3 NetworkPolicy Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getMatchLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getTypes patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new NetworkPolicy ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , void , NetworkPolicySpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : NetworkPolicySpec Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/networking.k8s.io/v1/networkpolicies\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"NetworkPolicy\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMatchLabels # \u25b8 getMatchLabels (): string [] Returns # string [] getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTypes # \u25b8 getTypes (): string [] Returns # string [] patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < NetworkPolicy > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: NetworkPolicy"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#class-networkpolicy","text":"Main . K8sApi .NetworkPolicy","title":"Class: NetworkPolicy"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , NetworkPolicySpec > \u21b3 NetworkPolicy","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getMatchLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getTypes patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#constructor","text":"\u2022 new NetworkPolicy ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#spec","text":"\u2022 spec : NetworkPolicySpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/networking.k8s.io/v1/networkpolicies\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#kind_1","text":"\u25aa Static Readonly kind : \"NetworkPolicy\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getmatchlabels","text":"\u25b8 getMatchLabels (): string []","title":"getMatchLabels"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#gettypes","text":"\u25b8 getTypes (): string []","title":"getTypes"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.NetworkPolicy/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Node/","text":"Class: Node # Main . K8sApi .Node Hierarchy # KubeObject < ClusterScopedMetadata , NodeStatus , NodeSpec > \u21b3 Node Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getActiveConditions getAge getAnnotations getConditions getCpuCapacity getCreationTimestamp getFinalizers getId getKubeletVersion getLabels getMemoryCapacity getName getNodeConditionText getNs getOperatingSystem getOwnerRefs getResourceVersion getRoleLabelItems getRoleLabels getScopedName getSearchFields getTaints getTimeDiffFromNow getWarningConditions isMasterNode isUnschedulable patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Node ( data ) Parameters # Name Type data KubeJsonApiData < ClusterScopedMetadata , NodeStatus , NodeSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : NodeSpec Inherited from # KubeObject . spec status # \u2022 Optional status : NodeStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/api/v1/nodes\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Node\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : false Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getActiveConditions # \u25b8 getActiveConditions (): NodeCondition [] Returns # NodeCondition [] getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getConditions # \u25b8 getConditions (): NodeCondition [] Returns # NodeCondition [] getCpuCapacity # \u25b8 getCpuCapacity (): undefined | number Returns # undefined | number getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getKubeletVersion # \u25b8 getKubeletVersion (): string Returns # string getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMemoryCapacity # \u25b8 getMemoryCapacity (): number Returns # number getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeConditionText # \u25b8 getNodeConditionText (): string Returns the concatination of all current condition types which have a status of \"True\" Returns # string getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOperatingSystem # \u25b8 getOperatingSystem (): string Returns # string getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRoleLabelItems # \u25b8 getRoleLabelItems (): string [] Returns # string [] getRoleLabels # \u25b8 getRoleLabels (): string Returns # string getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getTaints # \u25b8 getTaints (): NodeTaint [] Returns # NodeTaint [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getWarningConditions # \u25b8 getWarningConditions (): NodeCondition [] Returns # NodeCondition [] isMasterNode # \u25b8 isMasterNode (): boolean Returns # boolean isUnschedulable # \u25b8 isUnschedulable (): undefined | boolean Returns # undefined | boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Node > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Node"},{"location":"extensions/api/classes/Main.K8sApi.Node/#class-node","text":"Main . K8sApi .Node","title":"Class: Node"},{"location":"extensions/api/classes/Main.K8sApi.Node/#hierarchy","text":"KubeObject < ClusterScopedMetadata , NodeStatus , NodeSpec > \u21b3 Node","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Node/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Node/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Node/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Node/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Node/#methods","text":"delete getActiveConditions getAge getAnnotations getConditions getCpuCapacity getCreationTimestamp getFinalizers getId getKubeletVersion getLabels getMemoryCapacity getName getNodeConditionText getNs getOperatingSystem getOwnerRefs getResourceVersion getRoleLabelItems getRoleLabels getScopedName getSearchFields getTaints getTimeDiffFromNow getWarningConditions isMasterNode isUnschedulable patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Node/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Node/#constructor","text":"\u2022 new Node ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Node/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Node/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Node/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Node/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Node/#spec","text":"\u2022 spec : NodeSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Node/#status","text":"\u2022 Optional status : NodeStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Node/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/nodes\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Node/#kind_1","text":"\u25aa Static Readonly kind : \"Node\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Node/#namespaced","text":"\u25aa Static Readonly namespaced : false","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Node/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Node/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Node/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Node/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getactiveconditions","text":"\u25b8 getActiveConditions (): NodeCondition []","title":"getActiveConditions"},{"location":"extensions/api/classes/Main.K8sApi.Node/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getconditions","text":"\u25b8 getConditions (): NodeCondition []","title":"getConditions"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getcpucapacity","text":"\u25b8 getCpuCapacity (): undefined | number","title":"getCpuCapacity"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getkubeletversion","text":"\u25b8 getKubeletVersion (): string","title":"getKubeletVersion"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getmemorycapacity","text":"\u25b8 getMemoryCapacity (): number","title":"getMemoryCapacity"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getnodeconditiontext","text":"\u25b8 getNodeConditionText (): string Returns the concatination of all current condition types which have a status of \"True\"","title":"getNodeConditionText"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getoperatingsystem","text":"\u25b8 getOperatingSystem (): string","title":"getOperatingSystem"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getrolelabelitems","text":"\u25b8 getRoleLabelItems (): string []","title":"getRoleLabelItems"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getrolelabels","text":"\u25b8 getRoleLabels (): string","title":"getRoleLabels"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Node/#gettaints","text":"\u25b8 getTaints (): NodeTaint []","title":"getTaints"},{"location":"extensions/api/classes/Main.K8sApi.Node/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Node/#getwarningconditions","text":"\u25b8 getWarningConditions (): NodeCondition []","title":"getWarningConditions"},{"location":"extensions/api/classes/Main.K8sApi.Node/#ismasternode","text":"\u25b8 isMasterNode (): boolean","title":"isMasterNode"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isunschedulable","text":"\u25b8 isUnschedulable (): undefined | boolean","title":"isUnschedulable"},{"location":"extensions/api/classes/Main.K8sApi.Node/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Node/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Node/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Node/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Node/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Node/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Node/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Node/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Node/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Node/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/","text":"Class: PersistentVolume # Main . K8sApi .PersistentVolume Hierarchy # KubeObject < ClusterScopedMetadata , PersistentVolumeStatus , PersistentVolumeSpec > \u21b3 PersistentVolume Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCapacity getClaimRefName getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getStatus getStorageClass getStorageClassName getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new PersistentVolume ( data ) Parameters # Name Type data KubeJsonApiData < ClusterScopedMetadata , PersistentVolumeStatus , PersistentVolumeSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : PersistentVolumeSpec Inherited from # KubeObject . spec status # \u2022 Optional status : PersistentVolumeStatus Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCapacity # \u25b8 getCapacity ( inBytes? ): string | number Parameters # Name Type inBytes? boolean Returns # string | number getClaimRefName # \u25b8 getClaimRefName (): string Returns # string getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getStatus # \u25b8 getStatus (): string Returns # string getStorageClass # \u25b8 getStorageClass (): string Returns # string getStorageClassName # \u25b8 getStorageClassName (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < PersistentVolume > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: PersistentVolume"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#class-persistentvolume","text":"Main . K8sApi .PersistentVolume","title":"Class: PersistentVolume"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#hierarchy","text":"KubeObject < ClusterScopedMetadata , PersistentVolumeStatus , PersistentVolumeSpec > \u21b3 PersistentVolume","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#methods","text":"delete getAge getAnnotations getCapacity getClaimRefName getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getStatus getStorageClass getStorageClassName getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#constructor","text":"\u2022 new PersistentVolume ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#spec","text":"\u2022 spec : PersistentVolumeSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#status","text":"\u2022 Optional status : PersistentVolumeStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getcapacity","text":"\u25b8 getCapacity ( inBytes? ): string | number","title":"getCapacity"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getclaimrefname","text":"\u25b8 getClaimRefName (): string","title":"getClaimRefName"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getstatus","text":"\u25b8 getStatus (): string","title":"getStatus"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getstorageclass","text":"\u25b8 getStorageClass (): string","title":"getStorageClass"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#getstorageclassname","text":"\u25b8 getStorageClassName (): string","title":"getStorageClassName"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolume/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/","text":"Class: PersistentVolumeClaim # Main . K8sApi .PersistentVolumeClaim Hierarchy # KubeObject < NamespaceScopedMetadata , PersistentVolumeClaimStatus , PersistentVolumeClaimSpec > \u21b3 PersistentVolumeClaim Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getMatchExpressions getMatchLabels getName getNs getOwnerRefs getPods getResourceVersion getScopedName getSearchFields getStatus getStorage getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new PersistentVolumeClaim ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , PersistentVolumeClaimStatus , PersistentVolumeClaimSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : PersistentVolumeClaimSpec Inherited from # KubeObject . spec status # \u2022 Optional status : PersistentVolumeClaimStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/api/v1/persistentvolumeclaims\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"PersistentVolumeClaim\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMatchExpressions # \u25b8 getMatchExpressions (): LabelMatchExpression [] Returns # LabelMatchExpression [] getMatchLabels # \u25b8 getMatchLabels (): string [] Returns # string [] getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPods # \u25b8 getPods ( pods ): Pod [] Parameters # Name Type pods Pod [] Returns # Pod [] getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getStatus # \u25b8 getStatus (): string Returns # string getStorage # \u25b8 getStorage (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < PersistentVolumeClaim > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: PersistentVolumeClaim"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#class-persistentvolumeclaim","text":"Main . K8sApi .PersistentVolumeClaim","title":"Class: PersistentVolumeClaim"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , PersistentVolumeClaimStatus , PersistentVolumeClaimSpec > \u21b3 PersistentVolumeClaim","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getMatchExpressions getMatchLabels getName getNs getOwnerRefs getPods getResourceVersion getScopedName getSearchFields getStatus getStorage getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#constructor","text":"\u2022 new PersistentVolumeClaim ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#spec","text":"\u2022 spec : PersistentVolumeClaimSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#status","text":"\u2022 Optional status : PersistentVolumeClaimStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/persistentvolumeclaims\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#kind_1","text":"\u25aa Static Readonly kind : \"PersistentVolumeClaim\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getmatchexpressions","text":"\u25b8 getMatchExpressions (): LabelMatchExpression []","title":"getMatchExpressions"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getmatchlabels","text":"\u25b8 getMatchLabels (): string []","title":"getMatchLabels"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getpods","text":"\u25b8 getPods ( pods ): Pod []","title":"getPods"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getstatus","text":"\u25b8 getStatus (): string","title":"getStatus"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#getstorage","text":"\u25b8 getStorage (): string","title":"getStorage"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PersistentVolumeClaim/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Pod/","text":"Class: Pod # Main . K8sApi .Pod Hierarchy # KubeObject < NamespaceScopedMetadata , PodStatus , PodSpec > \u21b3 Pod Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAllContainers getAnnotations getConditions getContainerStatuses getContainers getCreationTimestamp getFinalizers getIPs getId getInitContainers getLabels getLivenessProbe getName getNodeName getNodeSelectors getNs getOwnerRefs getPriorityClassName getQosClass getReadinessProbe getReason getResourceVersion getRestartsCount getRunningContainers getRuntimeClassName getScopedName getSearchFields getSecrets getSelectedNodeOs getServiceAccountName getStartupProbe getStatus getStatusMessage getStatusPhase getTimeDiffFromNow getTolerations getVolumes hasIssues patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Pod ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , PodStatus , PodSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : PodSpec Inherited from # KubeObject . spec status # \u2022 Optional status : PodStatus Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAffinity # \u25b8 getAffinity (): Affinity Returns # Affinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAllContainers # \u25b8 getAllContainers (): IPodContainer [] Returns # IPodContainer [] getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getConditions # \u25b8 getConditions (): PodCondition [] Returns # PodCondition [] getContainerStatuses # \u25b8 getContainerStatuses ( includeInitContainers? ): IPodContainerStatus [] Parameters # Name Type includeInitContainers? boolean Returns # IPodContainerStatus [] getContainers # \u25b8 getContainers (): IPodContainer [] Returns # IPodContainer [] getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getIPs # \u25b8 getIPs (): string [] Returns # string [] getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getInitContainers # \u25b8 getInitContainers (): IPodContainer [] Returns # IPodContainer [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLivenessProbe # \u25b8 getLivenessProbe ( container ): string [] Parameters # Name Type container IPodContainer Returns # string [] getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeName # \u25b8 getNodeName (): undefined | string Returns # undefined | string getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPriorityClassName # \u25b8 getPriorityClassName (): string Returns # string getQosClass # \u25b8 getQosClass (): string Returns # string getReadinessProbe # \u25b8 getReadinessProbe ( container ): string [] Parameters # Name Type container IPodContainer Returns # string [] getReason # \u25b8 getReason (): string Returns # string getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRestartsCount # \u25b8 getRestartsCount (): number Returns # number getRunningContainers # \u25b8 getRunningContainers (): IPodContainer [] Returns # IPodContainer [] getRuntimeClassName # \u25b8 getRuntimeClassName (): string Returns # string getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSecrets # \u25b8 getSecrets (): string [] Returns # string [] getSelectedNodeOs # \u25b8 getSelectedNodeOs (): undefined | string Returns # undefined | string getServiceAccountName # \u25b8 getServiceAccountName (): string Returns # string getStartupProbe # \u25b8 getStartupProbe ( container ): string [] Parameters # Name Type container IPodContainer Returns # string [] getStatus # \u25b8 getStatus (): PodStatusPhase Returns # PodStatusPhase getStatusMessage # \u25b8 getStatusMessage (): string Returns # string getStatusPhase # \u25b8 getStatusPhase (): undefined | string Returns # undefined | string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): Toleration [] Returns # Toleration [] getVolumes # \u25b8 getVolumes (): PodSpecVolume [] Returns # PodSpecVolume [] hasIssues # \u25b8 hasIssues (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Pod > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Pod"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#class-pod","text":"Main . K8sApi .Pod","title":"Class: Pod"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , PodStatus , PodSpec > \u21b3 Pod","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#methods","text":"delete getAffinity getAffinityNumber getAge getAllContainers getAnnotations getConditions getContainerStatuses getContainers getCreationTimestamp getFinalizers getIPs getId getInitContainers getLabels getLivenessProbe getName getNodeName getNodeSelectors getNs getOwnerRefs getPriorityClassName getQosClass getReadinessProbe getReason getResourceVersion getRestartsCount getRunningContainers getRuntimeClassName getScopedName getSearchFields getSecrets getSelectedNodeOs getServiceAccountName getStartupProbe getStatus getStatusMessage getStatusPhase getTimeDiffFromNow getTolerations getVolumes hasIssues patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#constructor","text":"\u2022 new Pod ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#spec","text":"\u2022 spec : PodSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#status","text":"\u2022 Optional status : PodStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getaffinity","text":"\u25b8 getAffinity (): Affinity","title":"getAffinity"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getallcontainers","text":"\u25b8 getAllContainers (): IPodContainer []","title":"getAllContainers"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getconditions","text":"\u25b8 getConditions (): PodCondition []","title":"getConditions"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getcontainerstatuses","text":"\u25b8 getContainerStatuses ( includeInitContainers? ): IPodContainerStatus []","title":"getContainerStatuses"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getcontainers","text":"\u25b8 getContainers (): IPodContainer []","title":"getContainers"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getips","text":"\u25b8 getIPs (): string []","title":"getIPs"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getinitcontainers","text":"\u25b8 getInitContainers (): IPodContainer []","title":"getInitContainers"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getlivenessprobe","text":"\u25b8 getLivenessProbe ( container ): string []","title":"getLivenessProbe"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getnodename","text":"\u25b8 getNodeName (): undefined | string","title":"getNodeName"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getpriorityclassname","text":"\u25b8 getPriorityClassName (): string","title":"getPriorityClassName"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getqosclass","text":"\u25b8 getQosClass (): string","title":"getQosClass"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getreadinessprobe","text":"\u25b8 getReadinessProbe ( container ): string []","title":"getReadinessProbe"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getreason","text":"\u25b8 getReason (): string","title":"getReason"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getrestartscount","text":"\u25b8 getRestartsCount (): number","title":"getRestartsCount"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getrunningcontainers","text":"\u25b8 getRunningContainers (): IPodContainer []","title":"getRunningContainers"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getruntimeclassname","text":"\u25b8 getRuntimeClassName (): string","title":"getRuntimeClassName"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getsecrets","text":"\u25b8 getSecrets (): string []","title":"getSecrets"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getselectednodeos","text":"\u25b8 getSelectedNodeOs (): undefined | string","title":"getSelectedNodeOs"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getserviceaccountname","text":"\u25b8 getServiceAccountName (): string","title":"getServiceAccountName"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstartupprobe","text":"\u25b8 getStartupProbe ( container ): string []","title":"getStartupProbe"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstatus","text":"\u25b8 getStatus (): PodStatusPhase","title":"getStatus"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstatusmessage","text":"\u25b8 getStatusMessage (): string","title":"getStatusMessage"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getstatusphase","text":"\u25b8 getStatusPhase (): undefined | string","title":"getStatusPhase"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#gettolerations","text":"\u25b8 getTolerations (): Toleration []","title":"getTolerations"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#getvolumes","text":"\u25b8 getVolumes (): PodSpecVolume []","title":"getVolumes"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#hasissues","text":"\u25b8 hasIssues (): boolean","title":"hasIssues"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Pod/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/","text":"Class: PodDisruptionBudget # Main . K8sApi .PodDisruptionBudget Hierarchy # KubeObject < NamespaceScopedMetadata , PodDisruptionBudgetStatus , PodDisruptionBudgetSpec > \u21b3 PodDisruptionBudget Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getCurrentHealthy getDesiredHealthy getFinalizers getId getLabels getMaxUnavailable getMinAvailable getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSelectors getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new PodDisruptionBudget ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , PodDisruptionBudgetStatus , PodDisruptionBudgetSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : PodDisruptionBudgetSpec Inherited from # KubeObject . spec status # \u2022 Optional status : PodDisruptionBudgetStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/policy/v1beta1/poddisruptionbudgets\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"PodDisruptionBudget\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getCurrentHealthy # \u25b8 getCurrentHealthy (): number Returns # number getDesiredHealthy # \u25b8 getDesiredHealthy (): number Returns # number getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMaxUnavailable # \u25b8 getMaxUnavailable (): string | number Returns # string | number getMinAvailable # \u25b8 getMinAvailable (): string | number Returns # string | number getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < PodDisruptionBudget > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: PodDisruptionBudget"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#class-poddisruptionbudget","text":"Main . K8sApi .PodDisruptionBudget","title":"Class: PodDisruptionBudget"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , PodDisruptionBudgetStatus , PodDisruptionBudgetSpec > \u21b3 PodDisruptionBudget","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#methods","text":"delete getAge getAnnotations getCreationTimestamp getCurrentHealthy getDesiredHealthy getFinalizers getId getLabels getMaxUnavailable getMinAvailable getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSelectors getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#constructor","text":"\u2022 new PodDisruptionBudget ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#spec","text":"\u2022 spec : PodDisruptionBudgetSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#status","text":"\u2022 Optional status : PodDisruptionBudgetStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/policy/v1beta1/poddisruptionbudgets\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#kind_1","text":"\u25aa Static Readonly kind : \"PodDisruptionBudget\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getcurrenthealthy","text":"\u25b8 getCurrentHealthy (): number","title":"getCurrentHealthy"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getdesiredhealthy","text":"\u25b8 getDesiredHealthy (): number","title":"getDesiredHealthy"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getmaxunavailable","text":"\u25b8 getMaxUnavailable (): string | number","title":"getMaxUnavailable"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getminavailable","text":"\u25b8 getMinAvailable (): string | number","title":"getMinAvailable"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PodDisruptionBudget/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/","text":"Class: PriorityClass # Main . K8sApi .PriorityClass Hierarchy # KubeObject < ClusterScopedMetadata , void , void > \u21b3 PriorityClass Table of contents # Constructors # constructor Properties # apiVersion description globalDefault kind metadata preemptionPolicy spec status value apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getDescription getFinalizers getGlobalDefault getId getLabels getName getNs getOwnerRefs getPreemptionPolicy getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getValue patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new PriorityClass ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb PriorityClassData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion description # \u2022 Optional description : string globalDefault # \u2022 Optional globalDefault : boolean kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata preemptionPolicy # \u2022 Optional preemptionPolicy : PreemptionPolicy spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status value # \u2022 Optional value : number apiBase # \u25aa Static Readonly apiBase : \"/apis/scheduling.k8s.io/v1/priorityclasses\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"PriorityClass\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : false Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getDescription # \u25b8 getDescription (): string Returns # string getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getGlobalDefault # \u25b8 getGlobalDefault (): string Returns # string getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPreemptionPolicy # \u25b8 getPreemptionPolicy (): PreemptionPolicy Returns # PreemptionPolicy getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getValue # \u25b8 getValue (): undefined | number Returns # undefined | number patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < PriorityClass > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: PriorityClass"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#class-priorityclass","text":"Main . K8sApi .PriorityClass","title":"Class: PriorityClass"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#hierarchy","text":"KubeObject < ClusterScopedMetadata , void , void > \u21b3 PriorityClass","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#properties","text":"apiVersion description globalDefault kind metadata preemptionPolicy spec status value apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#methods","text":"delete getAge getAnnotations getCreationTimestamp getDescription getFinalizers getGlobalDefault getId getLabels getName getNs getOwnerRefs getPreemptionPolicy getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getValue patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#constructor","text":"\u2022 new PriorityClass ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#description","text":"\u2022 Optional description : string","title":"description"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#globaldefault","text":"\u2022 Optional globalDefault : boolean","title":"globalDefault"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#preemptionpolicy","text":"\u2022 Optional preemptionPolicy : PreemptionPolicy","title":"preemptionPolicy"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#value","text":"\u2022 Optional value : number","title":"value"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/scheduling.k8s.io/v1/priorityclasses\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#kind_1","text":"\u25aa Static Readonly kind : \"PriorityClass\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#namespaced","text":"\u25aa Static Readonly namespaced : false","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getdescription","text":"\u25b8 getDescription (): string","title":"getDescription"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getglobaldefault","text":"\u25b8 getGlobalDefault (): string","title":"getGlobalDefault"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getpreemptionpolicy","text":"\u25b8 getPreemptionPolicy (): PreemptionPolicy","title":"getPreemptionPolicy"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#getvalue","text":"\u25b8 getValue (): undefined | number","title":"getValue"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.PriorityClass/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/","text":"Class: ReplicaSet # Main . K8sApi .ReplicaSet Hierarchy # KubeObject < NamespaceScopedMetadata , ReplicaSetStatus , ReplicaSetSpec > \u21b3 ReplicaSet Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getCreationTimestamp getCurrent getDesired getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getReady getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ReplicaSet ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , ReplicaSetStatus , ReplicaSetSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : ReplicaSetSpec Inherited from # KubeObject . spec status # \u2022 Optional status : ReplicaSetStatus Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string Overrides # KubeObject . apiBase kind # \u25aa Static kind : string Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAffinity # \u25b8 getAffinity (): undefined | Affinity Returns # undefined | Affinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getCurrent # \u25b8 getCurrent (): number Returns # number getDesired # \u25b8 getDesired (): number Returns # number getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getImages # \u25b8 getImages (): ( undefined | string )[] Returns # ( undefined | string )[] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getReady # \u25b8 getReady (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): Toleration [] Returns # Toleration [] patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < ReplicaSet > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ReplicaSet"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#class-replicaset","text":"Main . K8sApi .ReplicaSet","title":"Class: ReplicaSet"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , ReplicaSetStatus , ReplicaSetSpec > \u21b3 ReplicaSet","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getCreationTimestamp getCurrent getDesired getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getReady getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#constructor","text":"\u2022 new ReplicaSet ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#spec","text":"\u2022 spec : ReplicaSetSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#status","text":"\u2022 Optional status : ReplicaSetStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#apibase","text":"\u25aa Static apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#kind_1","text":"\u25aa Static kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#namespaced","text":"\u25aa Static namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getaffinity","text":"\u25b8 getAffinity (): undefined | Affinity","title":"getAffinity"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getcurrent","text":"\u25b8 getCurrent (): number","title":"getCurrent"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getdesired","text":"\u25b8 getDesired (): number","title":"getDesired"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getimages","text":"\u25b8 getImages (): ( undefined | string )[]","title":"getImages"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getready","text":"\u25b8 getReady (): number","title":"getReady"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#gettolerations","text":"\u25b8 getTolerations (): Toleration []","title":"getTolerations"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ReplicaSet/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/","text":"Class: ResourceQuota # Main . K8sApi .ResourceQuota Hierarchy # KubeObject < NamespaceScopedMetadata , ResourceQuotaStatus , ResourceQuotaSpec > \u21b3 ResourceQuota Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopeSelector getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ResourceQuota ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , ResourceQuotaStatus , ResourceQuotaSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : ResourceQuotaSpec Inherited from # KubeObject . spec status # \u2022 Optional status : ResourceQuotaStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/api/v1/resourcequotas\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"ResourceQuota\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopeSelector # \u25b8 getScopeSelector (): { operator : string ; scopeName : string ; values : string [] }[] Returns # { operator : string ; scopeName : string ; values : string [] }[] getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < ResourceQuota > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ResourceQuota"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#class-resourcequota","text":"Main . K8sApi .ResourceQuota","title":"Class: ResourceQuota"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , ResourceQuotaStatus , ResourceQuotaSpec > \u21b3 ResourceQuota","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopeSelector getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#constructor","text":"\u2022 new ResourceQuota ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#spec","text":"\u2022 spec : ResourceQuotaSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#status","text":"\u2022 Optional status : ResourceQuotaStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/resourcequotas\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#kind_1","text":"\u25aa Static Readonly kind : \"ResourceQuota\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getscopeselector","text":"\u25b8 getScopeSelector (): { operator : string ; scopeName : string ; values : string [] }[]","title":"getScopeSelector"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ResourceQuota/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/","text":"Class: ResourceStack # Main . K8sApi .ResourceStack Deprecated Switch to using Common.createResourceStack instead Implements # ResourceApplyingStack Table of contents # Constructors # constructor Methods # kubectlApplyFolder kubectlDeleteFolder Constructors # constructor # \u2022 new ResourceStack ( cluster , name ) Parameters # Name Type cluster KubernetesCluster < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > name string Methods # kubectlApplyFolder # \u25b8 kubectlApplyFolder ( folderPath , templateContext? , extraArgs? ): Promise < string > Parameters # Name Type folderPath string templateContext? any extraArgs? string [] Returns # Promise < string > Implementation of # ResourceApplyingStack.kubectlApplyFolder kubectlDeleteFolder # \u25b8 kubectlDeleteFolder ( folderPath , templateContext? , extraArgs? ): Promise < string > Parameters # Name Type folderPath string templateContext? any extraArgs? string [] Returns # Promise < string > Implementation of # ResourceApplyingStack.kubectlDeleteFolder","title":"Class: ResourceStack"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#class-resourcestack","text":"Main . K8sApi .ResourceStack Deprecated Switch to using Common.createResourceStack instead","title":"Class: ResourceStack"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#implements","text":"ResourceApplyingStack","title":"Implements"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#methods","text":"kubectlApplyFolder kubectlDeleteFolder","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#constructor","text":"\u2022 new ResourceStack ( cluster , name )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#kubectlapplyfolder","text":"\u25b8 kubectlApplyFolder ( folderPath , templateContext? , extraArgs? ): Promise < string >","title":"kubectlApplyFolder"},{"location":"extensions/api/classes/Main.K8sApi.ResourceStack/#kubectldeletefolder","text":"\u25b8 kubectlDeleteFolder ( folderPath , templateContext? , extraArgs? ): Promise < string >","title":"kubectlDeleteFolder"},{"location":"extensions/api/classes/Main.K8sApi.Role/","text":"Class: Role # Main . K8sApi .Role Hierarchy # KubeObject < NamespaceScopedMetadata , void , void > \u21b3 Role Table of contents # Constructors # constructor Properties # apiVersion kind metadata rules spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Role ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb RoleData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata rules # \u2022 Optional rules : PolicyRule [] spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/rbac.authorization.k8s.io/v1/roles\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Role\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRules # \u25b8 getRules (): PolicyRule [] Returns # PolicyRule [] getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Role > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Role"},{"location":"extensions/api/classes/Main.K8sApi.Role/#class-role","text":"Main . K8sApi .Role","title":"Class: Role"},{"location":"extensions/api/classes/Main.K8sApi.Role/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , void > \u21b3 Role","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Role/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Role/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Role/#properties","text":"apiVersion kind metadata rules spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Role/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Role/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Role/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Role/#constructor","text":"\u2022 new Role ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Role/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Role/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Role/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Role/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Role/#rules","text":"\u2022 Optional rules : PolicyRule []","title":"rules"},{"location":"extensions/api/classes/Main.K8sApi.Role/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Role/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Role/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/rbac.authorization.k8s.io/v1/roles\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Role/#kind_1","text":"\u25aa Static Readonly kind : \"Role\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Role/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Role/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Role/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Role/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Role/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Role/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getrules","text":"\u25b8 getRules (): PolicyRule []","title":"getRules"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Role/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Role/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Role/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Role/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Role/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Role/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Role/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Role/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Role/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Role/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Role/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Role/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Role/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Role/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/","text":"Class: RoleBinding # Main . K8sApi .RoleBinding Hierarchy # KubeObject < NamespaceScopedMetadata , void , void > \u21b3 RoleBinding Table of contents # Constructors # constructor Properties # apiVersion kind metadata roleRef spec status subjects apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSubjectNames getSubjects getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new RoleBinding ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb RoleBindingData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata roleRef # \u2022 roleRef : RoleRef spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status subjects # \u2022 Optional subjects : Subject [] apiBase # \u25aa Static Readonly apiBase : \"/apis/rbac.authorization.k8s.io/v1/rolebindings\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"RoleBinding\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSubjectNames # \u25b8 getSubjectNames (): string Returns # string getSubjects # \u25b8 getSubjects (): Subject [] Returns # Subject [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < RoleBinding > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: RoleBinding"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#class-rolebinding","text":"Main . K8sApi .RoleBinding","title":"Class: RoleBinding"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , void > \u21b3 RoleBinding","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#properties","text":"apiVersion kind metadata roleRef spec status subjects apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSubjectNames getSubjects getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#constructor","text":"\u2022 new RoleBinding ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#roleref","text":"\u2022 roleRef : RoleRef","title":"roleRef"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#subjects","text":"\u2022 Optional subjects : Subject []","title":"subjects"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/rbac.authorization.k8s.io/v1/rolebindings\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#kind_1","text":"\u25aa Static Readonly kind : \"RoleBinding\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getsubjectnames","text":"\u25b8 getSubjectNames (): string","title":"getSubjectNames"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#getsubjects","text":"\u25b8 getSubjects (): Subject []","title":"getSubjects"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.RoleBinding/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Secret/","text":"Class: Secret # Main . K8sApi .Secret Hierarchy # KubeObject < NamespaceScopedMetadata , void , void > \u21b3 Secret Table of contents # Constructors # constructor Properties # apiVersion data kind metadata spec status type apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getToken patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Secret ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb SecretData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion data # \u2022 data : Partial < Record < string , string >> kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status type # \u2022 type : SecretType apiBase # \u25aa Static Readonly apiBase : \"/api/v1/secrets\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Secret\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getKeys # \u25b8 getKeys (): string [] Returns # string [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getToken # \u25b8 getToken (): undefined | string Returns # undefined | string patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Secret > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Secret"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#class-secret","text":"Main . K8sApi .Secret","title":"Class: Secret"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , void > \u21b3 Secret","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#properties","text":"apiVersion data kind metadata spec status type apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getToken patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#constructor","text":"\u2022 new Secret ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#data","text":"\u2022 data : Partial < Record < string , string >>","title":"data"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#type","text":"\u2022 type : SecretType","title":"type"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/secrets\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#kind_1","text":"\u25aa Static Readonly kind : \"Secret\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getkeys","text":"\u25b8 getKeys (): string []","title":"getKeys"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#gettoken","text":"\u25b8 getToken (): undefined | string","title":"getToken"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Secret/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.Service/","text":"Class: Service # Main . K8sApi .Service Hierarchy # KubeObject < NamespaceScopedMetadata , ServiceStatus , ServiceSpec > \u21b3 Service Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getClusterIp getClusterIps getCreationTimestamp getExternalIps getFinalizers getId getIpFamilies getIpFamilyPolicy getLabels getLoadBalancer getName getNs getOwnerRefs getPorts getResourceVersion getScopedName getSearchFields getSelector getStatus getTimeDiffFromNow getType isActive patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Service ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , ServiceStatus , ServiceSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : ServiceSpec Inherited from # KubeObject . spec status # \u2022 Optional status : ServiceStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/api/v1/services\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Service\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getClusterIp # \u25b8 getClusterIp (): string Returns # string getClusterIps # \u25b8 getClusterIps (): string [] Returns # string [] getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getExternalIps # \u25b8 getExternalIps (): ( undefined | string )[] Returns # ( undefined | string )[] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getIpFamilies # \u25b8 getIpFamilies (): string [] Returns # string [] getIpFamilyPolicy # \u25b8 getIpFamilyPolicy (): string Returns # string getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLoadBalancer # \u25b8 getLoadBalancer (): undefined | { ingress? : { hostname? : string ; ip? : string }[] } Returns # undefined | { ingress? : { hostname? : string ; ip? : string }[] } getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPorts # \u25b8 getPorts (): ServicePort [] Returns # ServicePort [] getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelector # \u25b8 getSelector (): string [] Returns # string [] getStatus # \u25b8 getStatus (): \"Active\" | \"Pending\" Returns # \"Active\" | \"Pending\" getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getType # \u25b8 getType (): string Returns # string isActive # \u25b8 isActive (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < Service > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Service"},{"location":"extensions/api/classes/Main.K8sApi.Service/#class-service","text":"Main . K8sApi .Service","title":"Class: Service"},{"location":"extensions/api/classes/Main.K8sApi.Service/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , ServiceStatus , ServiceSpec > \u21b3 Service","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.Service/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.Service/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Service/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Service/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Service/#methods","text":"delete getAge getAnnotations getClusterIp getClusterIps getCreationTimestamp getExternalIps getFinalizers getId getIpFamilies getIpFamilyPolicy getLabels getLoadBalancer getName getNs getOwnerRefs getPorts getResourceVersion getScopedName getSearchFields getSelector getStatus getTimeDiffFromNow getType isActive patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Service/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.Service/#constructor","text":"\u2022 new Service ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.Service/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.Service/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.Service/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Service/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.Service/#spec","text":"\u2022 spec : ServiceSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.Service/#status","text":"\u2022 Optional status : ServiceStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.Service/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/services\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.Service/#kind_1","text":"\u25aa Static Readonly kind : \"Service\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.Service/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.Service/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.Service/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.Service/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.Service/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.Service/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getclusterip","text":"\u25b8 getClusterIp (): string","title":"getClusterIp"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getclusterips","text":"\u25b8 getClusterIps (): string []","title":"getClusterIps"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getexternalips","text":"\u25b8 getExternalIps (): ( undefined | string )[]","title":"getExternalIps"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getipfamilies","text":"\u25b8 getIpFamilies (): string []","title":"getIpFamilies"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getipfamilypolicy","text":"\u25b8 getIpFamilyPolicy (): string","title":"getIpFamilyPolicy"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getloadbalancer","text":"\u25b8 getLoadBalancer (): undefined | { ingress? : { hostname? : string ; ip? : string }[] }","title":"getLoadBalancer"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getports","text":"\u25b8 getPorts (): ServicePort []","title":"getPorts"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getselector","text":"\u25b8 getSelector (): string []","title":"getSelector"},{"location":"extensions/api/classes/Main.K8sApi.Service/#getstatus","text":"\u25b8 getStatus (): \"Active\" | \"Pending\"","title":"getStatus"},{"location":"extensions/api/classes/Main.K8sApi.Service/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.Service/#gettype","text":"\u25b8 getType (): string","title":"getType"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isactive","text":"\u25b8 isActive (): boolean","title":"isActive"},{"location":"extensions/api/classes/Main.K8sApi.Service/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.Service/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.Service/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.Service/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.Service/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Service/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Service/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.Service/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.Service/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.Service/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/","text":"Class: ServiceAccount # Main . K8sApi .ServiceAccount Hierarchy # KubeObject < NamespaceScopedMetadata , void , void > \u21b3 ServiceAccount Table of contents # Constructors # constructor Properties # apiVersion automountServiceAccountToken imagePullSecrets kind metadata secrets spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getImagePullSecrets getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSecrets getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ServiceAccount ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb ServiceAccountData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion automountServiceAccountToken # \u2022 Optional automountServiceAccountToken : boolean imagePullSecrets # \u2022 Optional imagePullSecrets : LocalObjectReference [] kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata secrets # \u2022 Optional secrets : ObjectReference [] spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/api/v1/serviceaccounts\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"ServiceAccount\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getImagePullSecrets # \u25b8 getImagePullSecrets (): LocalObjectReference [] Returns # LocalObjectReference [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSecrets # \u25b8 getSecrets (): ObjectReference [] Returns # ObjectReference [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < ServiceAccount > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ServiceAccount"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#class-serviceaccount","text":"Main . K8sApi .ServiceAccount","title":"Class: ServiceAccount"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , void , void > \u21b3 ServiceAccount","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#properties","text":"apiVersion automountServiceAccountToken imagePullSecrets kind metadata secrets spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getImagePullSecrets getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSecrets getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#constructor","text":"\u2022 new ServiceAccount ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#automountserviceaccounttoken","text":"\u2022 Optional automountServiceAccountToken : boolean","title":"automountServiceAccountToken"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#imagepullsecrets","text":"\u2022 Optional imagePullSecrets : LocalObjectReference []","title":"imagePullSecrets"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#secrets","text":"\u2022 Optional secrets : ObjectReference []","title":"secrets"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#apibase","text":"\u25aa Static Readonly apiBase : \"/api/v1/serviceaccounts\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#kind_1","text":"\u25aa Static Readonly kind : \"ServiceAccount\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getimagepullsecrets","text":"\u25b8 getImagePullSecrets (): LocalObjectReference []","title":"getImagePullSecrets"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#getsecrets","text":"\u25b8 getSecrets (): ObjectReference []","title":"getSecrets"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.ServiceAccount/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/","text":"Class: StatefulSet # Main . K8sApi .StatefulSet Hierarchy # KubeObject < NamespaceScopedMetadata , StatefulSetStatus , StatefulSetSpec > \u21b3 StatefulSet Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getCreationTimestamp getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new StatefulSet ( data ) Parameters # Name Type data KubeJsonApiData < NamespaceScopedMetadata , StatefulSetStatus , StatefulSetSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : StatefulSetSpec Inherited from # KubeObject . spec status # \u2022 Optional status : StatefulSetStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/apps/v1/statefulsets\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"StatefulSet\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAffinity # \u25b8 getAffinity (): Affinity Returns # Affinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getImages # \u25b8 getImages (): ( undefined | string )[] Returns # ( undefined | string )[] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getReplicas # \u25b8 getReplicas (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): Toleration [] Returns # Toleration [] patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < StatefulSet > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: StatefulSet"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#class-statefulset","text":"Main . K8sApi .StatefulSet","title":"Class: StatefulSet"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#hierarchy","text":"KubeObject < NamespaceScopedMetadata , StatefulSetStatus , StatefulSetSpec > \u21b3 StatefulSet","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#properties","text":"apiVersion kind metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getCreationTimestamp getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getScopedName getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#constructor","text":"\u2022 new StatefulSet ( data )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#spec","text":"\u2022 spec : StatefulSetSpec","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#status","text":"\u2022 Optional status : StatefulSetStatus","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/apps/v1/statefulsets\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#kind_1","text":"\u25aa Static Readonly kind : \"StatefulSet\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#namespaced","text":"\u25aa Static Readonly namespaced : true","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getaffinity","text":"\u25b8 getAffinity (): Affinity","title":"getAffinity"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getimages","text":"\u25b8 getImages (): ( undefined | string )[]","title":"getImages"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getreplicas","text":"\u25b8 getReplicas (): number","title":"getReplicas"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#gettolerations","text":"\u25b8 getTolerations (): Toleration []","title":"getTolerations"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.StatefulSet/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/","text":"Class: StorageClass # Main . K8sApi .StorageClass Hierarchy # KubeObject < ClusterScopedMetadata , void , void > \u21b3 StorageClass Table of contents # Constructors # constructor Properties # allowVolumeExpansion allowedTopologies apiVersion kind metadata mountOptions parameters provisioner reclaimPolicy spec status volumeBindingMode apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getReclaimPolicy getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getVolumeBindingMode isDefault patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new StorageClass ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb StorageClassData Overrides # KubeObject . constructor Properties # allowVolumeExpansion # \u2022 Optional allowVolumeExpansion : boolean allowedTopologies # \u2022 allowedTopologies : TopologySelectorTerm [] apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata mountOptions # \u2022 mountOptions : string [] parameters # \u2022 parameters : Partial < Record < string , string >> provisioner # \u2022 provisioner : string reclaimPolicy # \u2022 reclaimPolicy : string spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status volumeBindingMode # \u2022 Optional volumeBindingMode : string apiBase # \u25aa Static Readonly apiBase : \"/apis/storage.k8s.io/v1/storageclasses\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"StorageClass\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : false Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \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 renderering Parameters # Name Type humanize? boolean compact? boolean fromNow? boolean Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type filter? boolean Returns # string [] Inherited from # KubeObject . getAnnotations getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getReclaimPolicy # \u25b8 getReclaimPolicy (): string Returns # string getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getVolumeBindingMode # \u25b8 getVolumeBindingMode (): string Returns # string isDefault # \u25b8 isDefault (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead Parameters # Name Type data Partial < StorageClass > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial> Parameters # Name Type object unknown Returns # object is Partial> Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: StorageClass"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#class-storageclass","text":"Main . K8sApi .StorageClass","title":"Class: StorageClass"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#hierarchy","text":"KubeObject < ClusterScopedMetadata , void , void > \u21b3 StorageClass","title":"Hierarchy"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#properties","text":"allowVolumeExpansion allowedTopologies apiVersion kind metadata mountOptions parameters provisioner reclaimPolicy spec status volumeBindingMode apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#methods","text":"delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getReclaimPolicy getResourceVersion getScopedName getSearchFields getTimeDiffFromNow getVolumeBindingMode isDefault patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#constructor","text":"\u2022 new StorageClass ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#allowvolumeexpansion","text":"\u2022 Optional allowVolumeExpansion : boolean","title":"allowVolumeExpansion"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#allowedtopologies","text":"\u2022 allowedTopologies : TopologySelectorTerm []","title":"allowedTopologies"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#mountoptions","text":"\u2022 mountOptions : string []","title":"mountOptions"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#parameters_1","text":"\u2022 parameters : Partial < Record < string , string >>","title":"parameters"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#provisioner","text":"\u2022 provisioner : string","title":"provisioner"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#reclaimpolicy","text":"\u2022 reclaimPolicy : string","title":"reclaimPolicy"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#volumebindingmode","text":"\u2022 Optional volumeBindingMode : string","title":"volumeBindingMode"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/storage.k8s.io/v1/storageclasses\"","title":"apiBase"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#kind_1","text":"\u25aa Static Readonly kind : \"StorageClass\"","title":"kind"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#namespaced","text":"\u25aa Static Readonly namespaced : false","title":"namespaced"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#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 renderering","title":"getAge"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getreclaimpolicy","text":"\u25b8 getReclaimPolicy (): string","title":"getReclaimPolicy"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number Deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#getvolumebindingmode","text":"\u25b8 getVolumeBindingMode (): string","title":"getVolumeBindingMode"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isdefault","text":"\u25b8 isDefault (): boolean","title":"isDefault"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","title":"isJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiObjectMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>>","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial>","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Main.K8sApi.StorageClass/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Main.LensExtension/","text":"Class: LensExtension # Main .LensExtension Hierarchy # LensExtension < LensMainExtensionDependencies > \u21b3 LensExtension Table of contents # Constructors # constructor Properties # appMenus id isBundled manifest manifestPath protocolHandlers terminalShellEnvModifier trayMenus Accessors # description isEnabled name sanitizedExtensionId storeName version Methods # activate addCatalogSource disable enable getExtensionFileFolder navigate onActivate onDeactivate removeCatalogSource Constructors # constructor # \u2022 new LensExtension ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb InstalledExtension Inherited from # LensExtension . constructor Properties # appMenus # \u2022 appMenus : MenuRegistration [] | IComputedValue < MenuRegistration []> id # \u2022 Readonly id : string Inherited from # LensExtension . id isBundled # \u2022 Readonly isBundled : boolean Inherited from # LensExtension . isBundled manifest # \u2022 Readonly manifest : LensExtensionManifest Inherited from # LensExtension . manifest manifestPath # \u2022 Readonly manifestPath : string Inherited from # LensExtension . manifestPath protocolHandlers # \u2022 protocolHandlers : ProtocolHandlerRegistration [] Inherited from # LensExtension . protocolHandlers terminalShellEnvModifier # \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. trayMenus # \u2022 trayMenus : TrayMenuRegistration [] | IComputedValue < TrayMenuRegistration []> Accessors # description # \u2022 get description (): undefined | string Returns # undefined | string Inherited from # LensExtension.description isEnabled # \u2022 get isEnabled (): boolean Returns # boolean Inherited from # LensExtension.isEnabled name # \u2022 get name (): string Returns # string Inherited from # LensExtension.name sanitizedExtensionId # \u2022 get sanitizedExtensionId (): string Returns # string Inherited from # LensExtension.sanitizedExtensionId storeName # \u2022 get storeName (): string Returns # string Inherited from # LensExtension.storeName version # \u2022 get version (): string Returns # string Inherited from # LensExtension.version Methods # activate # \u25b8 activate (): Promise < void > Returns # Promise < void > Inherited from # LensExtension . activate addCatalogSource # \u25b8 addCatalogSource ( id , source ): void Parameters # Name Type id string source IObservableArray < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >> | IComputedValue < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >[]> Returns # void disable # \u25b8 disable (): Promise < void > Returns # Promise < void > Inherited from # LensExtension . disable enable # \u25b8 enable (): Promise < void > Returns # Promise < void > Inherited from # LensExtension . enable getExtensionFileFolder # \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. Returns # Promise < string > Inherited from # LensExtension . getExtensionFileFolder navigate # \u25b8 navigate ( pageId? , params? , frameId? ): Promise < void > Parameters # Name Type pageId? string params? Record < string , any > frameId? number Returns # Promise < void > onActivate # \u25b8 Protected onActivate (): void | Promise < void > Returns # void | Promise < void > Inherited from # LensExtension . onActivate onDeactivate # \u25b8 Protected onDeactivate (): void | Promise < void > Returns # void | Promise < void > Inherited from # LensExtension . onDeactivate removeCatalogSource # \u25b8 removeCatalogSource ( id ): void Parameters # Name Type id string Returns # void","title":"Class: LensExtension"},{"location":"extensions/api/classes/Main.LensExtension/#class-lensextension","text":"Main .LensExtension","title":"Class: LensExtension"},{"location":"extensions/api/classes/Main.LensExtension/#hierarchy","text":"LensExtension < LensMainExtensionDependencies > \u21b3 LensExtension","title":"Hierarchy"},{"location":"extensions/api/classes/Main.LensExtension/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.LensExtension/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.LensExtension/#properties","text":"appMenus id isBundled manifest manifestPath protocolHandlers terminalShellEnvModifier trayMenus","title":"Properties"},{"location":"extensions/api/classes/Main.LensExtension/#accessors","text":"description isEnabled name sanitizedExtensionId storeName version","title":"Accessors"},{"location":"extensions/api/classes/Main.LensExtension/#methods","text":"activate addCatalogSource disable enable getExtensionFileFolder navigate onActivate onDeactivate removeCatalogSource","title":"Methods"},{"location":"extensions/api/classes/Main.LensExtension/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.LensExtension/#constructor","text":"\u2022 new LensExtension ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Main.LensExtension/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.LensExtension/#appmenus","text":"\u2022 appMenus : MenuRegistration [] | IComputedValue < MenuRegistration []>","title":"appMenus"},{"location":"extensions/api/classes/Main.LensExtension/#id","text":"\u2022 Readonly id : string","title":"id"},{"location":"extensions/api/classes/Main.LensExtension/#isbundled","text":"\u2022 Readonly isBundled : boolean","title":"isBundled"},{"location":"extensions/api/classes/Main.LensExtension/#manifest","text":"\u2022 Readonly manifest : LensExtensionManifest","title":"manifest"},{"location":"extensions/api/classes/Main.LensExtension/#manifestpath","text":"\u2022 Readonly manifestPath : string","title":"manifestPath"},{"location":"extensions/api/classes/Main.LensExtension/#protocolhandlers","text":"\u2022 protocolHandlers : ProtocolHandlerRegistration []","title":"protocolHandlers"},{"location":"extensions/api/classes/Main.LensExtension/#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.","title":"terminalShellEnvModifier"},{"location":"extensions/api/classes/Main.LensExtension/#traymenus","text":"\u2022 trayMenus : TrayMenuRegistration [] | IComputedValue < TrayMenuRegistration []>","title":"trayMenus"},{"location":"extensions/api/classes/Main.LensExtension/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.LensExtension/#description","text":"\u2022 get description (): undefined | string","title":"description"},{"location":"extensions/api/classes/Main.LensExtension/#isenabled","text":"\u2022 get isEnabled (): boolean","title":"isEnabled"},{"location":"extensions/api/classes/Main.LensExtension/#name","text":"\u2022 get name (): string","title":"name"},{"location":"extensions/api/classes/Main.LensExtension/#sanitizedextensionid","text":"\u2022 get sanitizedExtensionId (): string","title":"sanitizedExtensionId"},{"location":"extensions/api/classes/Main.LensExtension/#storename","text":"\u2022 get storeName (): string","title":"storeName"},{"location":"extensions/api/classes/Main.LensExtension/#version","text":"\u2022 get version (): string","title":"version"},{"location":"extensions/api/classes/Main.LensExtension/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.LensExtension/#activate","text":"\u25b8 activate (): Promise < void >","title":"activate"},{"location":"extensions/api/classes/Main.LensExtension/#addcatalogsource","text":"\u25b8 addCatalogSource ( id , source ): void","title":"addCatalogSource"},{"location":"extensions/api/classes/Main.LensExtension/#disable","text":"\u25b8 disable (): Promise < void >","title":"disable"},{"location":"extensions/api/classes/Main.LensExtension/#enable","text":"\u25b8 enable (): Promise < void >","title":"enable"},{"location":"extensions/api/classes/Main.LensExtension/#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.","title":"getExtensionFileFolder"},{"location":"extensions/api/classes/Main.LensExtension/#navigate","text":"\u25b8 navigate ( pageId? , params? , frameId? ): Promise < void >","title":"navigate"},{"location":"extensions/api/classes/Main.LensExtension/#onactivate","text":"\u25b8 Protected onActivate (): void | Promise < void >","title":"onActivate"},{"location":"extensions/api/classes/Main.LensExtension/#ondeactivate","text":"\u25b8 Protected onDeactivate (): void | Promise < void >","title":"onDeactivate"},{"location":"extensions/api/classes/Main.LensExtension/#removecatalogsource","text":"\u25b8 removeCatalogSource ( id ): void","title":"removeCatalogSource"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/","text":"Class: CatalogEntityRegistry # Renderer . Catalog .CatalogEntityRegistry Table of contents # Constructors # constructor Accessors # activeEntity entities Methods # addOnBeforeRun getById getItemsForApiKind getItemsForCategory Constructors # constructor # \u2022 new CatalogEntityRegistry () Accessors # activeEntity # \u2022 get activeEntity (): undefined | CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Currently active/visible entity Returns # undefined | CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > entities # \u2022 get entities (): Map < string , CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >> Returns # Map < string , CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >> Methods # addOnBeforeRun # \u25b8 addOnBeforeRun ( onBeforeRun ): Disposer Add a onBeforeRun hook to a catalog entities. If onBeforeRun was previously added then it will not be added again. Parameters # Name Type Description 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 Returns # Disposer A function to remove that hook getById # \u25b8 getById ( id ): undefined | CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Parameters # Name Type id string Returns # undefined | CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > getItemsForApiKind # \u25b8 getItemsForApiKind < T >( apiVersion , kind ): T [] Type parameters # Name Type T extends CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec , T > Parameters # Name Type apiVersion string kind string Returns # T [] getItemsForCategory # \u25b8 getItemsForCategory < T >( category ): T [] Type parameters # Name Type T extends CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec , T > Parameters # Name Type category CatalogCategory Returns # T []","title":"Class: CatalogEntityRegistry"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#class-catalogentityregistry","text":"Renderer . Catalog .CatalogEntityRegistry","title":"Class: CatalogEntityRegistry"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#accessors","text":"activeEntity entities","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#methods","text":"addOnBeforeRun getById getItemsForApiKind getItemsForCategory","title":"Methods"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructor","text":"\u2022 new CatalogEntityRegistry ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#activeentity","text":"\u2022 get activeEntity (): undefined | CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Currently active/visible entity","title":"activeEntity"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#entities","text":"\u2022 get entities (): Map < string , CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >>","title":"entities"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#addonbeforerun","text":"\u25b8 addOnBeforeRun ( onBeforeRun ): Disposer Add a onBeforeRun hook to a catalog entities. If onBeforeRun was previously added then it will not be added again.","title":"addOnBeforeRun"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getbyid","text":"\u25b8 getById ( id ): undefined | CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >","title":"getById"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getitemsforapikind","text":"\u25b8 getItemsForApiKind < T >( apiVersion , kind ): T []","title":"getItemsForApiKind"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getitemsforcategory","text":"\u25b8 getItemsForCategory < T >( category ): T []","title":"getItemsForCategory"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/","text":"Class: DrawerParamToggler # Renderer . Component .DrawerParamToggler Hierarchy # Component < DrawerParamTogglerProps , State > \u21b3 DrawerParamToggler Table of contents # Constructors # constructor Properties # state toggle Methods # render Constructors # constructor # \u2022 new DrawerParamToggler ( props ) Parameters # Name Type props DrawerParamTogglerProps | Readonly < DrawerParamTogglerProps > Inherited from # React.Component.constructor \u2022 new DrawerParamToggler ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props DrawerParamTogglerProps context any Inherited from # React.Component.constructor Properties # state # \u2022 state : State Overrides # React.Component.state toggle # \u2022 toggle : () => void Type declaration # \u25b8 (): void Returns # void Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: DrawerParamToggler"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#class-drawerparamtoggler","text":"Renderer . Component .DrawerParamToggler","title":"Class: DrawerParamToggler"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#hierarchy","text":"Component < DrawerParamTogglerProps , State > \u21b3 DrawerParamToggler","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#properties","text":"state toggle","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#constructor","text":"\u2022 new DrawerParamToggler ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#state","text":"\u2022 state : State","title":"state"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#toggle","text":"\u2022 toggle : () => void","title":"toggle"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Input/","text":"Class: Input # Renderer . Component .Input Hierarchy # Component < InputProps , State > \u21b3 Input Table of contents # Constructors # constructor Properties # input setDirtyOnChange state validators defaultProps Accessors # isUncontrolled showMaxLenIndicator themeSelection Methods # bindRef blur componentDidMount componentDidUpdate componentWillUnmount focus getValue onBlur onChange onFocus onKeyDown render select setDirty setValidation setValue validate Constructors # constructor # \u2022 new Input ( props ) Parameters # Name Type props InputProps Overrides # React.Component.constructor Properties # input # \u2022 input : null | InputElement setDirtyOnChange # \u2022 setDirtyOnChange : DebouncedFunc <() => void > state # \u2022 state : State Overrides # React.Component.state validators # \u2022 validators : InputValidator < boolean >[] defaultProps # \u25aa Static defaultProps : object Accessors # isUncontrolled # \u2022 get isUncontrolled (): boolean Returns # boolean showMaxLenIndicator # \u2022 get showMaxLenIndicator (): undefined | boolean | 0 Returns # undefined | boolean | 0 themeSelection # \u2022 get themeSelection (): Record < string , boolean > Returns # Record < string , boolean > Methods # bindRef # \u25b8 bindRef ( elem ): void Parameters # Name Type elem InputElement Returns # void blur # \u25b8 blur (): void Returns # void componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 componentDidUpdate ( prevProps ): void Parameters # Name Type prevProps InputProps Returns # void Overrides # React.Component.componentDidUpdate componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount focus # \u25b8 focus (): void Returns # void getValue # \u25b8 getValue (): string Returns # string onBlur # \u25b8 onBlur ( evt ): void Parameters # Name Type evt FocusEvent < InputElement , Element > Returns # void onChange # \u25b8 onChange ( evt ): Promise < void > Parameters # Name Type evt ChangeEvent < any > Returns # Promise < void > onFocus # \u25b8 onFocus ( evt ): void Parameters # Name Type evt FocusEvent < InputElement , Element > Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent < InputElement > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render select # \u25b8 select (): void Returns # void setDirty # \u25b8 setDirty ( dirty? ): void Parameters # Name Type dirty? boolean Returns # void setValidation # \u25b8 setValidation ( errors ): void Parameters # Name Type errors ReactNode [] Returns # void setValue # \u25b8 setValue ( value? ): void Parameters # Name Type value? string Returns # void validate # \u25b8 validate (): Promise < void > Returns # Promise < void >","title":"Class: Input"},{"location":"extensions/api/classes/Renderer.Component.Input/#class-input","text":"Renderer . Component .Input","title":"Class: Input"},{"location":"extensions/api/classes/Renderer.Component.Input/#hierarchy","text":"Component < InputProps , State > \u21b3 Input","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Input/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Input/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Input/#properties","text":"input setDirtyOnChange state validators defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Input/#accessors","text":"isUncontrolled showMaxLenIndicator themeSelection","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Input/#methods","text":"bindRef blur componentDidMount componentDidUpdate componentWillUnmount focus getValue onBlur onChange onFocus onKeyDown render select setDirty setValidation setValue validate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Input/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Input/#constructor","text":"\u2022 new Input ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Input/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Input/#input","text":"\u2022 input : null | InputElement","title":"input"},{"location":"extensions/api/classes/Renderer.Component.Input/#setdirtyonchange","text":"\u2022 setDirtyOnChange : DebouncedFunc <() => void >","title":"setDirtyOnChange"},{"location":"extensions/api/classes/Renderer.Component.Input/#state","text":"\u2022 state : State","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Input/#validators","text":"\u2022 validators : InputValidator < boolean >[]","title":"validators"},{"location":"extensions/api/classes/Renderer.Component.Input/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Input/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Input/#isuncontrolled","text":"\u2022 get isUncontrolled (): boolean","title":"isUncontrolled"},{"location":"extensions/api/classes/Renderer.Component.Input/#showmaxlenindicator","text":"\u2022 get showMaxLenIndicator (): undefined | boolean | 0","title":"showMaxLenIndicator"},{"location":"extensions/api/classes/Renderer.Component.Input/#themeselection","text":"\u2022 get themeSelection (): Record < string , boolean >","title":"themeSelection"},{"location":"extensions/api/classes/Renderer.Component.Input/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Input/#bindref","text":"\u25b8 bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/Renderer.Component.Input/#blur","text":"\u25b8 blur (): void","title":"blur"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentdidupdate","text":"\u25b8 componentDidUpdate ( prevProps ): void","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Input/#focus","text":"\u25b8 focus (): void","title":"focus"},{"location":"extensions/api/classes/Renderer.Component.Input/#getvalue","text":"\u25b8 getValue (): string","title":"getValue"},{"location":"extensions/api/classes/Renderer.Component.Input/#onblur","text":"\u25b8 onBlur ( evt ): void","title":"onBlur"},{"location":"extensions/api/classes/Renderer.Component.Input/#onchange","text":"\u25b8 onChange ( evt ): Promise < void >","title":"onChange"},{"location":"extensions/api/classes/Renderer.Component.Input/#onfocus","text":"\u25b8 onFocus ( evt ): void","title":"onFocus"},{"location":"extensions/api/classes/Renderer.Component.Input/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/Renderer.Component.Input/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Input/#select","text":"\u25b8 select (): void","title":"select"},{"location":"extensions/api/classes/Renderer.Component.Input/#setdirty","text":"\u25b8 setDirty ( dirty? ): void","title":"setDirty"},{"location":"extensions/api/classes/Renderer.Component.Input/#setvalidation","text":"\u25b8 setValidation ( errors ): void","title":"setValidation"},{"location":"extensions/api/classes/Renderer.Component.Input/#setvalue","text":"\u25b8 setValue ( value? ): void","title":"setValue"},{"location":"extensions/api/classes/Renderer.Component.Input/#validate","text":"\u25b8 validate (): Promise < void >","title":"validate"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/","text":"Class: MenuItem # Renderer . Component .MenuItem Hierarchy # Component < MenuItemProps > \u21b3 MenuItem Table of contents # Constructors # constructor Properties # context elem contextType defaultProps Accessors # isFocusable isLink Methods # bindRef onClick render Constructors # constructor # \u2022 new MenuItem ( props ) Parameters # Name Type props MenuItemProps Overrides # React.Component.constructor Properties # context # \u2022 context : MenuContextValue Overrides # React.Component.context elem # \u2022 elem : null | HTMLElement contextType # \u25aa Static contextType : Context < null | MenuContextValue > Overrides # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Accessors # isFocusable # \u2022 get isFocusable (): boolean Returns # boolean isLink # \u2022 get isLink (): boolean Returns # boolean Methods # bindRef # \u25b8 Protected bindRef ( elem ): void Parameters # Name Type elem HTMLElement Returns # void onClick # \u25b8 onClick ( evt ): void Parameters # Name Type evt MouseEvent < Element , MouseEvent > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: MenuItem"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#class-menuitem","text":"Renderer . Component .MenuItem","title":"Class: MenuItem"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#hierarchy","text":"Component < MenuItemProps > \u21b3 MenuItem","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#properties","text":"context elem contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#accessors","text":"isFocusable isLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#methods","text":"bindRef onClick render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#constructor","text":"\u2022 new MenuItem ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#context","text":"\u2022 context : MenuContextValue","title":"context"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#elem","text":"\u2022 elem : null | HTMLElement","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#contexttype","text":"\u25aa Static contextType : Context < null | MenuContextValue >","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#isfocusable","text":"\u2022 get isFocusable (): boolean","title":"isFocusable"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#islink","text":"\u2022 get isLink (): boolean","title":"isLink"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#bindref","text":"\u25b8 Protected bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#onclick","text":"\u25b8 onClick ( evt ): void","title":"onClick"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/","text":"Class: NotificationsStore # Renderer . Component .NotificationsStore Table of contents # Constructors # constructor Properties # autoHideTimers notifications Methods # add addAutoHideTimer getById remove removeAutoHideTimer Constructors # constructor # \u2022 new NotificationsStore () Properties # autoHideTimers # \u2022 Protected autoHideTimers : Map < NotificationId , number > notifications # \u2022 notifications : IObservableArray < Simplify < Except < Notification , \"id\" > & Required < Pick < Notification , \"id\" >>>> Methods # add # \u25b8 add ( rawNotification ): () => void Parameters # Name Type rawNotification Notification Returns # fn \u25b8 (): void Returns # void addAutoHideTimer # \u25b8 addAutoHideTimer ( id ): void Parameters # Name Type id NotificationId Returns # void getById # \u25b8 getById ( id ): undefined | Simplify < Except < Notification , \"id\" > & Required < Pick < Notification , \"id\" >>> Parameters # Name Type id NotificationId Returns # undefined | Simplify < Except < Notification , \"id\" > & Required < Pick < Notification , \"id\" >>> remove # \u25b8 remove ( id ): void Parameters # Name Type id NotificationId Returns # void removeAutoHideTimer # \u25b8 removeAutoHideTimer ( id ): void Parameters # Name Type id NotificationId Returns # void","title":"Class: NotificationsStore"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#class-notificationsstore","text":"Renderer . Component .NotificationsStore","title":"Class: NotificationsStore"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#properties","text":"autoHideTimers notifications","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#methods","text":"add addAutoHideTimer getById remove removeAutoHideTimer","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructor","text":"\u2022 new NotificationsStore ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#autohidetimers","text":"\u2022 Protected autoHideTimers : Map < NotificationId , number >","title":"autoHideTimers"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#notifications","text":"\u2022 notifications : IObservableArray < Simplify < Except < Notification , \"id\" > & Required < Pick < Notification , \"id\" >>>>","title":"notifications"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#add","text":"\u25b8 add ( rawNotification ): () => void","title":"add"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#addautohidetimer","text":"\u25b8 addAutoHideTimer ( id ): void","title":"addAutoHideTimer"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Simplify < Except < Notification , \"id\" > & Required < Pick < Notification , \"id\" >>>","title":"getById"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#remove","text":"\u25b8 remove ( id ): void","title":"remove"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#removeautohidetimer","text":"\u25b8 removeAutoHideTimer ( id ): void","title":"removeAutoHideTimer"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/","text":"Class: PageLayout # Renderer . Component .PageLayout PageLayout is deprecated. See MainLayout & SettingLayout Deprecated Hierarchy # SettingLayout \u21b3 PageLayout Table of contents # Constructors # constructor Properties # onEscapeKey defaultProps Methods # componentDidMount componentWillUnmount render Constructors # constructor # \u2022 new PageLayout ( props ) Parameters # Name Type props SettingLayoutProps | Readonly < SettingLayoutProps > Inherited from # SettingLayout . constructor \u2022 new PageLayout ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SettingLayoutProps context any Inherited from # SettingLayout . constructor Properties # onEscapeKey # \u2022 onEscapeKey : ( evt : KeyboardEvent ) => void Type declaration # \u25b8 ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void Inherited from # SettingLayout . onEscapeKey defaultProps # \u25aa Static defaultProps : object Inherited from # SettingLayout . defaultProps Methods # componentDidMount # \u25b8 componentDidMount (): Promise < void > Returns # Promise < void > Inherited from # SettingLayout . componentDidMount componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Inherited from # SettingLayout . componentWillUnmount render # \u25b8 render (): Element Returns # Element Inherited from # SettingLayout . render","title":"Class: PageLayout"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#class-pagelayout","text":"Renderer . Component .PageLayout PageLayout is deprecated. See MainLayout & SettingLayout Deprecated","title":"Class: PageLayout"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#hierarchy","text":"SettingLayout \u21b3 PageLayout","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#properties","text":"onEscapeKey defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#methods","text":"componentDidMount componentWillUnmount render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#constructor","text":"\u2022 new PageLayout ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#onescapekey","text":"\u2022 onEscapeKey : ( evt : KeyboardEvent ) => void","title":"onEscapeKey"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentdidmount","text":"\u25b8 componentDidMount (): Promise < void >","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/","text":"Class: SettingLayout # Renderer . Component .SettingLayout Layout for settings like pages with navigation Hierarchy # Component < SettingLayoutProps > \u21b3 SettingLayout \u21b3\u21b3 PageLayout Table of contents # Constructors # constructor Properties # onEscapeKey defaultProps Methods # componentDidMount componentWillUnmount render Constructors # constructor # \u2022 new SettingLayout ( props ) Parameters # Name Type props SettingLayoutProps | Readonly < SettingLayoutProps > Inherited from # React.Component.constructor \u2022 new SettingLayout ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SettingLayoutProps context any Inherited from # React.Component.constructor Properties # onEscapeKey # \u2022 onEscapeKey : ( evt : KeyboardEvent ) => void Type declaration # \u25b8 ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void defaultProps # \u25aa Static defaultProps : object Methods # componentDidMount # \u25b8 componentDidMount (): Promise < void > Returns # Promise < void > Overrides # React.Component.componentDidMount componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: SettingLayout"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#class-settinglayout","text":"Renderer . Component .SettingLayout Layout for settings like pages with navigation","title":"Class: SettingLayout"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#hierarchy","text":"Component < SettingLayoutProps > \u21b3 SettingLayout \u21b3\u21b3 PageLayout","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#properties","text":"onEscapeKey defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#methods","text":"componentDidMount componentWillUnmount render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#constructor","text":"\u2022 new SettingLayout ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#onescapekey","text":"\u2022 onEscapeKey : ( evt : KeyboardEvent ) => void","title":"onEscapeKey"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentdidmount","text":"\u25b8 componentDidMount (): Promise < void >","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Slider/","text":"Class: Slider # Renderer . Component .Slider Hierarchy # Component < SliderProps > \u21b3 Slider Table of contents # Constructors # constructor Properties # defaultProps Methods # render Constructors # constructor # \u2022 new Slider ( props ) Parameters # Name Type props SliderProps | Readonly < SliderProps > Inherited from # Component.constructor \u2022 new Slider ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SliderProps context any Inherited from # Component.constructor Properties # defaultProps # \u25aa Static defaultProps : object Methods # render # \u25b8 render (): Element Returns # Element Overrides # Component.render","title":"Class: Slider"},{"location":"extensions/api/classes/Renderer.Component.Slider/#class-slider","text":"Renderer . Component .Slider","title":"Class: Slider"},{"location":"extensions/api/classes/Renderer.Component.Slider/#hierarchy","text":"Component < SliderProps > \u21b3 Slider","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Slider/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Slider/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Slider/#properties","text":"defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Slider/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Slider/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Slider/#constructor","text":"\u2022 new Slider ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Slider/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Slider/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Slider/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Slider/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Spinner/","text":"Class: Spinner # Renderer . Component .Spinner Hierarchy # Component < SpinnerProps , {}> \u21b3 Spinner Table of contents # Constructors # constructor Properties # defaultProps Methods # render Constructors # constructor # \u2022 new Spinner ( props ) Parameters # Name Type props SpinnerProps | Readonly < SpinnerProps > Inherited from # React.Component.constructor \u2022 new Spinner ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SpinnerProps context any Inherited from # React.Component.constructor Properties # defaultProps # \u25aa Static defaultProps : Object Type declaration # Name Type center boolean singleColor boolean Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: Spinner"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#class-spinner","text":"Renderer . Component .Spinner","title":"Class: Spinner"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#hierarchy","text":"Component < SpinnerProps , {}> \u21b3 Spinner","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#properties","text":"defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#constructor","text":"\u2022 new Spinner ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#defaultprops","text":"\u25aa Static defaultProps : Object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Stepper/","text":"Class: Stepper # Renderer . Component .Stepper Hierarchy # Component < StepperProps , {}> \u21b3 Stepper Table of contents # Constructors # constructor Methods # render Constructors # constructor # \u2022 new Stepper ( props ) Parameters # Name Type props StepperProps | Readonly < StepperProps > Inherited from # React.Component.constructor \u2022 new Stepper ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props StepperProps context any Inherited from # React.Component.constructor Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: Stepper"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#class-stepper","text":"Renderer . Component .Stepper","title":"Class: Stepper"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#hierarchy","text":"Component < StepperProps , {}> \u21b3 Stepper","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#constructor","text":"\u2022 new Stepper ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/","text":"Class: SubTitle # Renderer . Component .SubTitle Hierarchy # Component < SubTitleProps > \u21b3 SubTitle Table of contents # Constructors # constructor Methods # render Constructors # constructor # \u2022 new SubTitle ( props ) Parameters # Name Type props SubTitleProps | Readonly < SubTitleProps > Inherited from # React.Component.constructor \u2022 new SubTitle ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SubTitleProps context any Inherited from # React.Component.constructor Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: SubTitle"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#class-subtitle","text":"Renderer . Component .SubTitle","title":"Class: SubTitle"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#hierarchy","text":"Component < SubTitleProps > \u21b3 SubTitle","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#constructor","text":"\u2022 new SubTitle ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Tab/","text":"Class: Tab # Renderer . Component .Tab Type parameters # Name D Hierarchy # PureComponent < TabProps < D >> \u21b3 Tab Table of contents # Constructors # constructor Properties # context ref contextType Accessors # isActive Methods # componentDidMount focus onClick onFocus onKeyDown render scrollIntoView Constructors # constructor # \u2022 new Tab < D >( props ) Type parameters # Name D Parameters # Name Type props TabProps < D > Overrides # React.PureComponent\\>.constructor Properties # context # \u2022 context : TabsContextValue < D > Overrides # React.PureComponent.context ref # \u2022 ref : RefObject < HTMLDivElement > contextType # \u25aa Static contextType : Context < TabsContextValue < unknown >> Overrides # React.PureComponent.contextType Accessors # isActive # \u2022 get isActive (): boolean Returns # boolean Methods # componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.PureComponent.componentDidMount focus # \u25b8 focus (): void Returns # void onClick # \u25b8 onClick ( evt ): void Parameters # Name Type evt MouseEvent < HTMLElement , MouseEvent > Returns # void onFocus # \u25b8 onFocus ( evt ): void Parameters # Name Type evt FocusEvent < HTMLElement , Element > Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent < HTMLElement > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render scrollIntoView # \u25b8 scrollIntoView (): void Returns # void","title":"Class: Tab"},{"location":"extensions/api/classes/Renderer.Component.Tab/#class-tabd","text":"Renderer . Component .Tab","title":"Class: Tab<D>"},{"location":"extensions/api/classes/Renderer.Component.Tab/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.Tab/#hierarchy","text":"PureComponent < TabProps < D >> \u21b3 Tab","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Tab/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Tab/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tab/#properties","text":"context ref contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tab/#accessors","text":"isActive","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Tab/#methods","text":"componentDidMount focus onClick onFocus onKeyDown render scrollIntoView","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tab/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tab/#constructor","text":"\u2022 new Tab < D >( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Tab/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tab/#context","text":"\u2022 context : TabsContextValue < D >","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Tab/#ref","text":"\u2022 ref : RefObject < HTMLDivElement >","title":"ref"},{"location":"extensions/api/classes/Renderer.Component.Tab/#contexttype","text":"\u25aa Static contextType : Context < TabsContextValue < unknown >>","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Tab/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Tab/#isactive","text":"\u2022 get isActive (): boolean","title":"isActive"},{"location":"extensions/api/classes/Renderer.Component.Tab/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tab/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Tab/#focus","text":"\u25b8 focus (): void","title":"focus"},{"location":"extensions/api/classes/Renderer.Component.Tab/#onclick","text":"\u25b8 onClick ( evt ): void","title":"onClick"},{"location":"extensions/api/classes/Renderer.Component.Tab/#onfocus","text":"\u25b8 onFocus ( evt ): void","title":"onFocus"},{"location":"extensions/api/classes/Renderer.Component.Tab/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/Renderer.Component.Tab/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Tab/#scrollintoview","text":"\u25b8 scrollIntoView (): void","title":"scrollIntoView"},{"location":"extensions/api/classes/Renderer.Component.TableCell/","text":"Class: TableCell # Renderer . Component .TableCell Hierarchy # Component < TableCellProps > \u21b3 TableCell Table of contents # Constructors # constructor Methods # onClick render renderCheckbox renderSortIcon Constructors # constructor # \u2022 new TableCell ( props ) Parameters # Name Type props TableCellProps Overrides # React.Component.constructor Methods # onClick # \u25b8 onClick ( evt ): void Parameters # Name Type evt MouseEvent < HTMLDivElement , MouseEvent > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render renderCheckbox # \u25b8 renderCheckbox (): null | Element Returns # null | Element renderSortIcon # \u25b8 renderSortIcon (): null | Element Returns # null | Element","title":"Class: TableCell"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#class-tablecell","text":"Renderer . Component .TableCell","title":"Class: TableCell"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#hierarchy","text":"Component < TableCellProps > \u21b3 TableCell","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#methods","text":"onClick render renderCheckbox renderSortIcon","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#constructor","text":"\u2022 new TableCell ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#onclick","text":"\u25b8 onClick ( evt ): void","title":"onClick"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#rendercheckbox","text":"\u25b8 renderCheckbox (): null | Element","title":"renderCheckbox"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#rendersorticon","text":"\u25b8 renderSortIcon (): null | Element","title":"renderSortIcon"},{"location":"extensions/api/classes/Renderer.Component.TableHead/","text":"Class: TableHead # Renderer . Component .TableHead Hierarchy # Component < TableHeadProps > \u21b3 TableHead Table of contents # Constructors # constructor Properties # defaultProps Methods # render Constructors # constructor # \u2022 new TableHead ( props ) Parameters # Name Type props TableHeadProps | Readonly < TableHeadProps > Inherited from # React.Component.constructor \u2022 new TableHead ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props TableHeadProps context any Inherited from # React.Component.constructor Properties # defaultProps # \u25aa Static defaultProps : TableHeadProps Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: TableHead"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#class-tablehead","text":"Renderer . Component .TableHead","title":"Class: TableHead"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#hierarchy","text":"Component < TableHeadProps > \u21b3 TableHead","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#properties","text":"defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#constructor","text":"\u2022 new TableHead ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#defaultprops","text":"\u25aa Static defaultProps : TableHeadProps","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.TableRow/","text":"Class: TableRow # Renderer . Component .TableRow Type parameters # Name Item Hierarchy # Component < TableRowProps < Item >> \u21b3 TableRow Table of contents # Constructors # constructor Methods # render Constructors # constructor # \u2022 new TableRow < Item >( props ) Type parameters # Name Item Parameters # Name Type props TableRowProps < Item > | Readonly < TableRowProps < Item >> Inherited from # React.Component>.constructor \u2022 new TableRow < Item >( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Type parameters # Name Item Parameters # Name Type props TableRowProps < Item > context any Inherited from # React.Component>.constructor Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: TableRow"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#class-tablerowitem","text":"Renderer . Component .TableRow","title":"Class: TableRow<Item>"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#type-parameters","text":"Name Item","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#hierarchy","text":"Component < TableRowProps < Item >> \u21b3 TableRow","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#constructor","text":"\u2022 new TableRow < Item >( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Tabs/","text":"Class: Tabs # Renderer . Component .Tabs Type parameters # Name D Hierarchy # PureComponent < TabsProps < D >> \u21b3 Tabs Table of contents # Constructors # constructor Properties # elem Methods # render Constructors # constructor # \u2022 new Tabs < D >( props ) Type parameters # Name D Parameters # Name Type props TabsProps < D > | Readonly < TabsProps < D >> Inherited from # React.PureComponent>.constructor \u2022 new Tabs < D >( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Type parameters # Name D Parameters # Name Type props TabsProps < D > context any Inherited from # React.PureComponent>.constructor Properties # elem # \u2022 elem : null | HTMLDivElement Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render","title":"Class: Tabs"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#class-tabsd","text":"Renderer . Component .Tabs","title":"Class: Tabs<D>"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#hierarchy","text":"PureComponent < TabsProps < D >> \u21b3 Tabs","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#properties","text":"elem","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#constructor","text":"\u2022 new Tabs < D >( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#elem","text":"\u2022 elem : null | HTMLDivElement","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/","text":"Class: TerminalStore # Renderer . Component .TerminalStore Table of contents # Constructors # constructor Methods # createInstance getInstance resetInstance Constructors # constructor # \u2022 new TerminalStore () Methods # createInstance # \u25b8 Static createInstance (): TerminalStore & { sendCommand : SendCommand } Returns # TerminalStore & { sendCommand : SendCommand } getInstance # \u25b8 Static getInstance (): TerminalStore & { sendCommand : SendCommand } Returns # TerminalStore & { sendCommand : SendCommand } resetInstance # \u25b8 Static resetInstance (): void Returns # void","title":"Class: TerminalStore"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#class-terminalstore","text":"Renderer . Component .TerminalStore","title":"Class: TerminalStore"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#methods","text":"createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructor","text":"\u2022 new TerminalStore ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#createinstance","text":"\u25b8 Static createInstance (): TerminalStore & { sendCommand : SendCommand }","title":"createInstance"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#getinstance","text":"\u25b8 Static getInstance (): TerminalStore & { sendCommand : SendCommand }","title":"getInstance"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#resetinstance","text":"\u25b8 Static resetInstance (): void","title":"resetInstance"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/","text":"Class: Tooltip # Renderer . Component .Tooltip Hierarchy # Component < TooltipProps > \u21b3 Tooltip Table of contents # Constructors # constructor Properties # activePosition elem isContentVisible isVisible defaultProps Accessors # hoverTarget targetElem Methods # componentDidMount componentDidUpdate componentWillUnmount getPosition onEnterTarget onLeaveTarget refreshPosition render setPosition Constructors # constructor # \u2022 new Tooltip ( props ) Parameters # Name Type props TooltipProps Overrides # React.Component.constructor Properties # activePosition # \u2022 Optional activePosition : TooltipPosition elem # \u2022 elem : null | HTMLDivElement isContentVisible # \u2022 isContentVisible : boolean isVisible # \u2022 isVisible : boolean defaultProps # \u25aa Static defaultProps : object Accessors # hoverTarget # \u2022 get hoverTarget (): null | HTMLElement Returns # null | HTMLElement targetElem # \u2022 get targetElem (): null | HTMLElement Returns # null | HTMLElement Methods # componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 componentDidUpdate (): void Returns # void Overrides # React.Component.componentDidUpdate componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount getPosition # \u25b8 Protected getPosition ( position , tooltipBounds , targetBounds ): Object Parameters # Name Type position TooltipPosition tooltipBounds DOMRect targetBounds DOMRect Returns # Object Name Type bottom number left number right number top number onEnterTarget # \u25b8 Protected onEnterTarget (): void Returns # void onLeaveTarget # \u25b8 Protected onLeaveTarget (): void Returns # void refreshPosition # \u25b8 refreshPosition (): void Returns # void render # \u25b8 render (): null | Element Returns # null | Element Overrides # React.Component.render setPosition # \u25b8 Protected setPosition ( elem , pos ): void Parameters # Name Type elem HTMLDivElement pos Object pos.left number pos.top number Returns # void","title":"Class: Tooltip"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#class-tooltip","text":"Renderer . Component .Tooltip","title":"Class: Tooltip"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#hierarchy","text":"Component < TooltipProps > \u21b3 Tooltip","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#properties","text":"activePosition elem isContentVisible isVisible defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#accessors","text":"hoverTarget targetElem","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#methods","text":"componentDidMount componentDidUpdate componentWillUnmount getPosition onEnterTarget onLeaveTarget refreshPosition render setPosition","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#constructor","text":"\u2022 new Tooltip ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#activeposition","text":"\u2022 Optional activePosition : TooltipPosition","title":"activePosition"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#elem","text":"\u2022 elem : null | HTMLDivElement","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#iscontentvisible","text":"\u2022 isContentVisible : boolean","title":"isContentVisible"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#isvisible","text":"\u2022 isVisible : boolean","title":"isVisible"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#hovertarget","text":"\u2022 get hoverTarget (): null | HTMLElement","title":"hoverTarget"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#targetelem","text":"\u2022 get targetElem (): null | HTMLElement","title":"targetElem"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#componentdidupdate","text":"\u25b8 componentDidUpdate (): void","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#getposition","text":"\u25b8 Protected getPosition ( position , tooltipBounds , targetBounds ): Object","title":"getPosition"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#onentertarget","text":"\u25b8 Protected onEnterTarget (): void","title":"onEnterTarget"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#onleavetarget","text":"\u25b8 Protected onLeaveTarget (): void","title":"onLeaveTarget"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#refreshposition","text":"\u25b8 refreshPosition (): void","title":"refreshPosition"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#render","text":"\u25b8 render (): null | Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#setposition","text":"\u25b8 Protected setPosition ( elem , pos ): void","title":"setPosition"},{"location":"extensions/api/classes/Renderer.Component.Wizard/","text":"Class: Wizard # Renderer . Component .Wizard Type parameters # Name D Hierarchy # Component < WizardProps < D >, State > \u21b3 Wizard Table of contents # Constructors # constructor Properties # firstStep isFirstStep isLastStep lastStep nextStep prevStep state Accessors # step steps Methods # getValidStep render Constructors # constructor # \u2022 new Wizard < D >( props ) Type parameters # Name D Parameters # Name Type props WizardProps < D > | Readonly < WizardProps < D >> Inherited from # React.Component, State>.constructor \u2022 new Wizard < D >( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Type parameters # Name D Parameters # Name Type props WizardProps < D > context any Inherited from # React.Component, State>.constructor Properties # firstStep # \u2022 firstStep : () => any Type declaration # \u25b8 (): any Returns # any isFirstStep # \u2022 isFirstStep : () => boolean Type declaration # \u25b8 (): boolean Returns # boolean isLastStep # \u2022 isLastStep : () => boolean Type declaration # \u25b8 (): boolean Returns # boolean lastStep # \u2022 lastStep : () => any Type declaration # \u25b8 (): any Returns # any nextStep # \u2022 nextStep : () => any Type declaration # \u25b8 (): any Returns # any prevStep # \u2022 prevStep : () => any Type declaration # \u25b8 (): any Returns # any state # \u2022 state : State Overrides # React.Component.state Accessors # step # \u2022 get step (): number Returns # number \u2022 set step ( step ): void Parameters # Name Type step number Returns # void steps # \u2022 get steps (): ReactElement < WizardStepProps < D >, string | JSXElementConstructor < any >>[] Returns # ReactElement < WizardStepProps < D >, string | JSXElementConstructor < any >>[] Methods # getValidStep # \u25b8 Protected getValidStep ( step ): number Parameters # Name Type step number Returns # number render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: Wizard"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#class-wizardd","text":"Renderer . Component .Wizard","title":"Class: Wizard<D>"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#hierarchy","text":"Component < WizardProps < D >, State > \u21b3 Wizard","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#properties","text":"firstStep isFirstStep isLastStep lastStep nextStep prevStep state","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#accessors","text":"step steps","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#methods","text":"getValidStep render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#constructor","text":"\u2022 new Wizard < D >( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#firststep","text":"\u2022 firstStep : () => any","title":"firstStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#isfirststep","text":"\u2022 isFirstStep : () => boolean","title":"isFirstStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#islaststep","text":"\u2022 isLastStep : () => boolean","title":"isLastStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#laststep","text":"\u2022 lastStep : () => any","title":"lastStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#nextstep","text":"\u2022 nextStep : () => any","title":"nextStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#prevstep","text":"\u2022 prevStep : () => any","title":"prevStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#state","text":"\u2022 state : State","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#step","text":"\u2022 get step (): number","title":"step"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#steps","text":"\u2022 get steps (): ReactElement < WizardStepProps < D >, string | JSXElementConstructor < any >>[]","title":"steps"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#getvalidstep","text":"\u25b8 Protected getValidStep ( step ): number","title":"getValidStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/","text":"Class: WizardLayout # Renderer . Component .WizardLayout Hierarchy # Component < WizardLayoutProps > \u21b3 WizardLayout Table of contents # Constructors # constructor Methods # render Constructors # constructor # \u2022 new WizardLayout ( props ) Parameters # Name Type props WizardLayoutProps | Readonly < WizardLayoutProps > Inherited from # React.Component.constructor \u2022 new WizardLayout ( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Parameters # Name Type props WizardLayoutProps context any Inherited from # React.Component.constructor Methods # render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render","title":"Class: WizardLayout"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#class-wizardlayout","text":"Renderer . Component .WizardLayout","title":"Class: WizardLayout"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#hierarchy","text":"Component < WizardLayoutProps > \u21b3 WizardLayout","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#methods","text":"render","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#constructor","text":"\u2022 new WizardLayout ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/","text":"Class: WizardStep # Renderer . Component .WizardStep Type parameters # Name D Hierarchy # Component < WizardStepProps < D >, WizardStepState > \u21b3 WizardStep Table of contents # Constructors # constructor Properties # next prev state submit defaultProps Methods # componentWillUnmount keyDown render renderLoading Constructors # constructor # \u2022 new WizardStep < D >( props ) Type parameters # Name D Parameters # Name Type props WizardStepProps < D > | Readonly < WizardStepProps < D >> Inherited from # React.Component, WizardStepState>.constructor \u2022 new WizardStep < D >( props , context ) Deprecated See https://reactjs.org/docs/legacy-context.html Type parameters # Name D Parameters # Name Type props WizardStepProps < D > context any Inherited from # React.Component, WizardStepState>.constructor Properties # next # \u2022 next : () => void Type declaration # \u25b8 (): void Returns # void prev # \u2022 prev : () => void Type declaration # \u25b8 (): void Returns # void state # \u2022 state : WizardStepState Overrides # React.Component.state submit # \u2022 submit : DebouncedFunc <() => void > defaultProps # \u25aa Static defaultProps : WizardStepProps < any > Methods # componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount keyDown # \u25b8 keyDown ( evt ): void Parameters # Name Type evt KeyboardEvent < HTMLElement > Returns # void render # \u25b8 render (): null | Element Returns # null | Element Overrides # React.Component.render renderLoading # \u25b8 renderLoading (): Element Returns # Element","title":"Class: WizardStep"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#class-wizardstepd","text":"Renderer . Component .WizardStep","title":"Class: WizardStep<D>"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#hierarchy","text":"Component < WizardStepProps < D >, WizardStepState > \u21b3 WizardStep","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#properties","text":"next prev state submit defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#methods","text":"componentWillUnmount keyDown render renderLoading","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#constructor","text":"\u2022 new WizardStep < D >( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#next","text":"\u2022 next : () => void","title":"next"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#prev","text":"\u2022 prev : () => void","title":"prev"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#state","text":"\u2022 state : WizardStepState","title":"state"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#submit","text":"\u2022 submit : DebouncedFunc <() => void >","title":"submit"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#defaultprops","text":"\u25aa Static defaultProps : WizardStepProps < any >","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#keydown","text":"\u25b8 keyDown ( evt ): void","title":"keyDown"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#render","text":"\u25b8 render (): null | Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#renderloading","text":"\u25b8 renderLoading (): Element","title":"renderLoading"},{"location":"extensions/api/classes/Renderer.Ipc/","text":"Class: Ipc # Renderer .Ipc Hierarchy # IpcRegistrar \u21b3 Ipc Table of contents # Constructors # constructor Properties # [IpcPrefix] extension Methods # broadcast invoke listen createInstance getInstance resetInstance Constructors # constructor # \u2022 new Ipc ( extension ) Parameters # Name Type extension LensExtension Overrides # IpcRegistrar.constructor Properties # [IpcPrefix] # \u2022 Readonly [IpcPrefix] : string Inherited from # IpcRegistrar.__@IpcPrefix@1575 extension # \u2022 Protected Readonly extension : LensExtension < LensExtensionDependencies > Inherited from # IpcRegistrar.extension Methods # broadcast # \u25b8 broadcast ( channel , ...args ): void Parameters # Name Type Description channel string The channel to broadcast to your whole extension, both main and renderer ...args any [] The arguments passed to all listeners Returns # void Inherited from # IpcRegistrar.broadcast invoke # \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. Parameters # Name Type Description channel string The channel to invoke a RPC on ...args any [] The arguments to pass to the RPC Returns # Promise < any > A promise of the resulting value listen # \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. Parameters # Name Type Description 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 Returns # Disposer An optional disposer, Lens will cleanup even if this is not called createInstance # \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. Type parameters # Name Type T extends Singleton < T > R extends any [] Parameters # Name Type Description this StaticThis < T , R > Implicit argument that is the child class type ...args R The constructor arguments for the child class Returns # T An instance of the child class Inherited from # IpcRegistrar.createInstance getInstance # \u25b8 Static getInstance < T , R >( this , strict? ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R extends any [] Parameters # 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 Returns # T An instance of the child class Inherited from # IpcRegistrar.getInstance \u25b8 Static getInstance < T , R >( this , strict ): undefined | T Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > strict false Returns # undefined | T Inherited from # IpcRegistrar.getInstance resetInstance # \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. Returns # void Inherited from # IpcRegistrar.resetInstance","title":"Class: Ipc"},{"location":"extensions/api/classes/Renderer.Ipc/#class-ipc","text":"Renderer .Ipc","title":"Class: Ipc"},{"location":"extensions/api/classes/Renderer.Ipc/#hierarchy","text":"IpcRegistrar \u21b3 Ipc","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Ipc/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Ipc/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Ipc/#properties","text":"[IpcPrefix] extension","title":"Properties"},{"location":"extensions/api/classes/Renderer.Ipc/#methods","text":"broadcast invoke listen createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/Renderer.Ipc/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Ipc/#constructor","text":"\u2022 new Ipc ( extension )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Ipc/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Ipc/#ipcprefix","text":"\u2022 Readonly [IpcPrefix] : string","title":"[IpcPrefix]"},{"location":"extensions/api/classes/Renderer.Ipc/#extension","text":"\u2022 Protected Readonly extension : LensExtension < LensExtensionDependencies >","title":"extension"},{"location":"extensions/api/classes/Renderer.Ipc/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Ipc/#broadcast","text":"\u25b8 broadcast ( channel , ...args ): void","title":"broadcast"},{"location":"extensions/api/classes/Renderer.Ipc/#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.","title":"invoke"},{"location":"extensions/api/classes/Renderer.Ipc/#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.","title":"listen"},{"location":"extensions/api/classes/Renderer.Ipc/#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.","title":"createInstance"},{"location":"extensions/api/classes/Renderer.Ipc/#getinstance","text":"\u25b8 Static getInstance < T , R >( this , strict? ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/Renderer.Ipc/#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.","title":"resetInstance"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/","text":"Class: CRDResourceStore # Renderer . K8sApi .CRDResourceStore Type parameters # Name Type K extends KubeObject Hierarchy # KubeObjectStore < K , KubeApi < K >> \u21b3 CRDResourceStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new CRDResourceStore < K >( deps , api ) Type parameters # Name Type K extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , K > Parameters # Name Type deps KubeObjectStoreDependencies api KubeApi < K , KubeJsonApiDataFor < K >> Overrides # KubeObjectStore\\>.constructor Properties # api # \u2022 Readonly api : KubeApi < K , KubeJsonApiDataFor < K >> Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : K ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item K Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiDataFor < K > extends KubeJsonApiDataFor < K > ? KubeJsonApiDataFor < K > : never >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < K > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < K , void , undefined > Returns # Generator < K , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string data? PartialDeep < K > Returns # Promise < K > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | K > Parameters # Name Type params Object params.name string params.namespace? string data? PartialDeep < K > Returns # Promise < null | K > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): K [] Parameters # Name Type items K [] Returns # K [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): K [] Parameters # Name Type namespace string | string [] strict? boolean Returns # K [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | K Parameters # Name Type id string Returns # undefined | K Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): K [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # K [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | K Parameters # Name Type name string namespace? string Returns # undefined | K Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | K Parameters # Name Type path string Returns # undefined | K Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): K [] Returns # K [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item K Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? K [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < K > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | K []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | K []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < K > Parameters # Name Type resourcePath string Returns # Promise < K > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | K > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | K > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < K []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < K []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): K [] Parameters # Name Type partialItems K [] \u00abdestructured\u00bb MergeItemsOptions Returns # K [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < K > Parameters # Name Type item K patch Patch Returns # Promise < K > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): K [] Parameters # Name Type items K [] Returns # K [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | K []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | K []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item K Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item K request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items K [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item K Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # K [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item K Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? K [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item K Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < K > Parameters # Name Type item K data PartialDeep < K > Returns # Promise < K > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < K > Parameters # Name Type item K request () => Promise < K > Returns # Promise < K > Inherited from # KubeObjectStore.updateItem","title":"Class: CRDResourceStore"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#class-crdresourcestorek","text":"Renderer . K8sApi .CRDResourceStore","title":"Class: CRDResourceStore<K>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#type-parameters","text":"Name Type K extends KubeObject","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#hierarchy","text":"KubeObjectStore < K , KubeApi < K >> \u21b3 CRDResourceStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#constructor","text":"\u2022 new CRDResourceStore < K >( deps , api )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#api","text":"\u2022 Readonly api : KubeApi < K , KubeJsonApiDataFor < K >>","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : K ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiDataFor < K > extends KubeJsonApiDataFor < K > ? KubeJsonApiDataFor < K > : never >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#items","text":"\u2022 items : IObservableArray < K >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#iterator","text":"\u25b8 [iterator] (): Generator < K , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#create","text":"\u25b8 create ( params , data? ): Promise < K >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | K >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): K []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): K []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbyid","text":"\u25b8 getById ( id ): undefined | K","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): K []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | K","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | K","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getitems","text":"\u25b8 getItems (): K []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#load","text":"\u25b8 load ( params ): Promise < K >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | K []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < K >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | K >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < K []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): K []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < K >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): K []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | K []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#update","text":"\u25b8 update ( item , data ): Promise < K >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < K >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/","text":"Class: CRDStore # Renderer . K8sApi .CRDStore Hierarchy # KubeObjectStore < CustomResourceDefinition , CustomResourceDefinitionApi > \u21b3 CRDStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems groups query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getByGroup getById getByLabel getByName getByObject getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new CRDStore ( dependencies , api , opts? ) Parameters # Name Type dependencies CustomResourceDefinitionStoreDependencies api CustomResourceDefinitionApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : CustomResourceDefinitionApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : CustomResourceDefinition ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item CustomResourceDefinition Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : CustomResourceDefinitionStoreDependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , CustomResourceDefinitionStatus , CustomResourceDefinitionSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < CustomResourceDefinition > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems groups # \u2022 get groups (): Record < string , CustomResourceDefinition []> Returns # Record < string , CustomResourceDefinition []> query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < CustomResourceDefinition , void , undefined > Returns # Generator < CustomResourceDefinition , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < CustomResourceDefinition > Returns # Promise < null | CustomResourceDefinition > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): CustomResourceDefinition [] Parameters # Name Type items CustomResourceDefinition [] Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): CustomResourceDefinition [] Parameters # Name Type namespace string | string [] strict? boolean Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore.getAllByNs getByGroup # \u25b8 getByGroup ( group , pluralName ): undefined | CustomResourceDefinition Parameters # Name Type group string pluralName string Returns # undefined | CustomResourceDefinition getById # \u25b8 getById ( id ): undefined | CustomResourceDefinition Parameters # Name Type id string Returns # undefined | CustomResourceDefinition Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): CustomResourceDefinition [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | CustomResourceDefinition Parameters # Name Type name string namespace? string Returns # undefined | CustomResourceDefinition Inherited from # KubeObjectStore.getByName getByObject # \u25b8 getByObject ( obj ): undefined | CustomResourceDefinition Parameters # Name Type obj KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # undefined | CustomResourceDefinition getByPath # \u25b8 getByPath ( path ): undefined | CustomResourceDefinition Parameters # Name Type path string Returns # undefined | CustomResourceDefinition Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): CustomResourceDefinition [] Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item CustomResourceDefinition Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? CustomResourceDefinition [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | CustomResourceDefinition []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | CustomResourceDefinition []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < CustomResourceDefinition > Parameters # Name Type resourcePath string Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | CustomResourceDefinition > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < CustomResourceDefinition []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < CustomResourceDefinition []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): CustomResourceDefinition [] Parameters # Name Type partialItems CustomResourceDefinition [] \u00abdestructured\u00bb MergeItemsOptions Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < CustomResourceDefinition > Parameters # Name Type item CustomResourceDefinition patch Patch Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): CustomResourceDefinition [] Parameters # Name Type items CustomResourceDefinition [] Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | CustomResourceDefinition []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | CustomResourceDefinition []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item CustomResourceDefinition Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item CustomResourceDefinition request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items CustomResourceDefinition [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item CustomResourceDefinition Returns # void Inherited from # KubeObjectStore.select sortItems # \u25b8 Protected sortItems ( items ): CustomResourceDefinition [] Parameters # Name Type items CustomResourceDefinition [] Returns # CustomResourceDefinition [] Overrides # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item CustomResourceDefinition Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? CustomResourceDefinition [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item CustomResourceDefinition Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < CustomResourceDefinition > Parameters # Name Type item CustomResourceDefinition data PartialObjectDeep < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < CustomResourceDefinition > Parameters # Name Type item CustomResourceDefinition request () => Promise < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore.updateItem","title":"Class: CRDStore"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#class-crdstore","text":"Renderer . K8sApi .CRDStore","title":"Class: CRDStore"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#hierarchy","text":"KubeObjectStore < CustomResourceDefinition , CustomResourceDefinitionApi > \u21b3 CRDStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#accessors","text":"contextItems groups query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getByGroup getById getByLabel getByName getByObject getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#constructor","text":"\u2022 new CRDStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#api","text":"\u2022 Readonly api : CustomResourceDefinitionApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : CustomResourceDefinition ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#dependencies","text":"\u2022 Protected Readonly dependencies : CustomResourceDefinitionStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , CustomResourceDefinitionStatus , CustomResourceDefinitionSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#items","text":"\u2022 items : IObservableArray < CustomResourceDefinition >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#groups","text":"\u2022 get groups (): Record < string , CustomResourceDefinition []>","title":"groups"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#iterator","text":"\u25b8 [iterator] (): Generator < CustomResourceDefinition , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#create","text":"\u25b8 create ( params , data? ): Promise < CustomResourceDefinition >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | CustomResourceDefinition >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): CustomResourceDefinition []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): CustomResourceDefinition []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbygroup","text":"\u25b8 getByGroup ( group , pluralName ): undefined | CustomResourceDefinition","title":"getByGroup"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyid","text":"\u25b8 getById ( id ): undefined | CustomResourceDefinition","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): CustomResourceDefinition []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | CustomResourceDefinition","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyobject","text":"\u25b8 getByObject ( obj ): undefined | CustomResourceDefinition","title":"getByObject"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | CustomResourceDefinition","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getitems","text":"\u25b8 getItems (): CustomResourceDefinition []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#load","text":"\u25b8 load ( params ): Promise < CustomResourceDefinition >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | CustomResourceDefinition []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < CustomResourceDefinition >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | CustomResourceDefinition >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < CustomResourceDefinition []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): CustomResourceDefinition []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < CustomResourceDefinition >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): CustomResourceDefinition []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | CustomResourceDefinition []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#sortitems","text":"\u25b8 Protected sortItems ( items ): CustomResourceDefinition []","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#update","text":"\u25b8 update ( item , data ): Promise < CustomResourceDefinition >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < CustomResourceDefinition >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/","text":"Class: ConfigMapsStore # Renderer . K8sApi .ConfigMapsStore Hierarchy # KubeObjectStore < ConfigMap , ConfigMapApi , ConfigMapData > \u21b3 ConfigMapsStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ConfigMapsStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api ConfigMapApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : ConfigMapApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : ConfigMap ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item ConfigMap Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < ConfigMapData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < ConfigMap > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < ConfigMap , void , undefined > Returns # Generator < ConfigMap , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < ConfigMap > Returns # Promise < ConfigMap > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < ConfigMap > Returns # Promise < null | ConfigMap > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): ConfigMap [] Parameters # Name Type items ConfigMap [] Returns # ConfigMap [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): ConfigMap [] Parameters # Name Type namespace string | string [] strict? boolean Returns # ConfigMap [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | ConfigMap Parameters # Name Type id string Returns # undefined | ConfigMap Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): ConfigMap [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # ConfigMap [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | ConfigMap Parameters # Name Type name string namespace? string Returns # undefined | ConfigMap Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | ConfigMap Parameters # Name Type path string Returns # undefined | ConfigMap Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): ConfigMap [] Returns # ConfigMap [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item ConfigMap Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? ConfigMap [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ConfigMap > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ConfigMap []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | ConfigMap []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < ConfigMap > Parameters # Name Type resourcePath string Returns # Promise < ConfigMap > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | ConfigMap > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ConfigMap []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < ConfigMap []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ConfigMap [] Parameters # Name Type partialItems ConfigMap [] \u00abdestructured\u00bb MergeItemsOptions Returns # ConfigMap [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < ConfigMap > Parameters # Name Type item ConfigMap patch Patch Returns # Promise < ConfigMap > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): ConfigMap [] Parameters # Name Type items ConfigMap [] Returns # ConfigMap [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | ConfigMap []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | ConfigMap []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item ConfigMap Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item ConfigMap request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items ConfigMap [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item ConfigMap Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # ConfigMap [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item ConfigMap Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? ConfigMap [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item ConfigMap Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < ConfigMap > Parameters # Name Type item ConfigMap data PartialObjectDeep < ConfigMap > Returns # Promise < ConfigMap > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < ConfigMap > Parameters # Name Type item ConfigMap request () => Promise < ConfigMap > Returns # Promise < ConfigMap > Inherited from # KubeObjectStore.updateItem","title":"Class: ConfigMapsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#class-configmapsstore","text":"Renderer . K8sApi .ConfigMapsStore","title":"Class: ConfigMapsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#hierarchy","text":"KubeObjectStore < ConfigMap , ConfigMapApi , ConfigMapData > \u21b3 ConfigMapsStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#constructor","text":"\u2022 new ConfigMapsStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#api","text":"\u2022 Readonly api : ConfigMapApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : ConfigMap ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < ConfigMapData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#items","text":"\u2022 items : IObservableArray < ConfigMap >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#iterator","text":"\u25b8 [iterator] (): Generator < ConfigMap , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#create","text":"\u25b8 create ( params , data? ): Promise < ConfigMap >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | ConfigMap >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): ConfigMap []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): ConfigMap []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbyid","text":"\u25b8 getById ( id ): undefined | ConfigMap","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): ConfigMap []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | ConfigMap","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | ConfigMap","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getitems","text":"\u25b8 getItems (): ConfigMap []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#load","text":"\u25b8 load ( params ): Promise < ConfigMap >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ConfigMap []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < ConfigMap >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | ConfigMap >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ConfigMap []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ConfigMap []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < ConfigMap >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): ConfigMap []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | ConfigMap []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#update","text":"\u25b8 update ( item , data ): Promise < ConfigMap >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < ConfigMap >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/","text":"Class: CronJobStore # Renderer . K8sApi .CronJobStore Hierarchy # KubeObjectStore < CronJob , CronJobApi > \u21b3 CronJobStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getActiveJobsNum getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new CronJobStore ( dependencies , api , opts? ) Parameters # Name Type dependencies Dependencies api CronJobApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : CronJobApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : CronJob ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item CronJob Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : Dependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , CronJobStatus , CronJobSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < CronJob > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < CronJob , void , undefined > Returns # Generator < CronJob , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < CronJob > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < CronJob > Returns # Promise < CronJob > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | CronJob > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < CronJob > Returns # Promise < null | CronJob > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): CronJob [] Parameters # Name Type items CronJob [] Returns # CronJob [] Inherited from # KubeObjectStore.filterItemsOnLoad getActiveJobsNum # \u25b8 getActiveJobsNum ( cronJob ): number Parameters # Name Type cronJob CronJob Returns # number getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): CronJob [] Parameters # Name Type namespace string | string [] strict? boolean Returns # CronJob [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | CronJob Parameters # Name Type id string Returns # undefined | CronJob Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): CronJob [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # CronJob [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | CronJob Parameters # Name Type name string namespace? string Returns # undefined | CronJob Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | CronJob Parameters # Name Type path string Returns # undefined | CronJob Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): CronJob [] Returns # CronJob [] Inherited from # KubeObjectStore.getItems getStatuses # \u25b8 getStatuses ( cronJobs? ): Object Parameters # Name Type cronJobs? CronJob [] Returns # Object Name Type scheduled number suspended number getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item CronJob Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? CronJob [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < CronJob > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < CronJob > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | CronJob []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | CronJob []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < CronJob > Parameters # Name Type resourcePath string Returns # Promise < CronJob > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | CronJob > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | CronJob > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < CronJob []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < CronJob []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): CronJob [] Parameters # Name Type partialItems CronJob [] \u00abdestructured\u00bb MergeItemsOptions Returns # CronJob [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < CronJob > Parameters # Name Type item CronJob patch Patch Returns # Promise < CronJob > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): CronJob [] Parameters # Name Type items CronJob [] Returns # CronJob [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | CronJob []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | CronJob []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item CronJob Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item CronJob request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items CronJob [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item CronJob Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # CronJob [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item CronJob Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? CronJob [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item CronJob Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < CronJob > Parameters # Name Type item CronJob data PartialObjectDeep < CronJob > Returns # Promise < CronJob > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < CronJob > Parameters # Name Type item CronJob request () => Promise < CronJob > Returns # Promise < CronJob > Inherited from # KubeObjectStore.updateItem","title":"Class: CronJobStore"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#class-cronjobstore","text":"Renderer . K8sApi .CronJobStore","title":"Class: CronJobStore"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#hierarchy","text":"KubeObjectStore < CronJob , CronJobApi > \u21b3 CronJobStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getActiveJobsNum getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#constructor","text":"\u2022 new CronJobStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#api","text":"\u2022 Readonly api : CronJobApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : CronJob ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#dependencies","text":"\u2022 Protected Readonly dependencies : Dependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , CronJobStatus , CronJobSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#items","text":"\u2022 items : IObservableArray < CronJob >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#iterator","text":"\u25b8 [iterator] (): Generator < CronJob , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#create","text":"\u25b8 create ( params , data? ): Promise < CronJob >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | CronJob >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): CronJob []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getactivejobsnum","text":"\u25b8 getActiveJobsNum ( cronJob ): number","title":"getActiveJobsNum"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): CronJob []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbyid","text":"\u25b8 getById ( id ): undefined | CronJob","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): CronJob []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | CronJob","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | CronJob","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getitems","text":"\u25b8 getItems (): CronJob []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getstatuses","text":"\u25b8 getStatuses ( cronJobs? ): Object","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#load","text":"\u25b8 load ( params ): Promise < CronJob >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | CronJob []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < CronJob >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | CronJob >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < CronJob []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): CronJob []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < CronJob >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): CronJob []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | CronJob []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#update","text":"\u25b8 update ( item , data ): Promise < CronJob >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < CronJob >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/","text":"Class: DaemonSetStore # Renderer . K8sApi .DaemonSetStore Hierarchy # KubeObjectStore < DaemonSet , DaemonSetApi > \u21b3 DaemonSetStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new DaemonSetStore ( dependencies , api , opts? ) Parameters # Name Type dependencies DaemonSetStoreDependencies api DaemonSetApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : DaemonSetApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : DaemonSet ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item DaemonSet Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : DaemonSetStoreDependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , DaemonSetStatus , DaemonSetSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < DaemonSet > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < DaemonSet , void , undefined > Returns # Generator < DaemonSet , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < DaemonSet > Returns # Promise < DaemonSet > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < DaemonSet > Returns # Promise < null | DaemonSet > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): DaemonSet [] Parameters # Name Type items DaemonSet [] Returns # DaemonSet [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): DaemonSet [] Parameters # Name Type namespace string | string [] strict? boolean Returns # DaemonSet [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | DaemonSet Parameters # Name Type id string Returns # undefined | DaemonSet Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): DaemonSet [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # DaemonSet [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | DaemonSet Parameters # Name Type name string namespace? string Returns # undefined | DaemonSet Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | DaemonSet Parameters # Name Type path string Returns # undefined | DaemonSet Inherited from # KubeObjectStore.getByPath getChildPods # \u25b8 getChildPods ( daemonSet ): Pod [] Parameters # Name Type daemonSet DaemonSet Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): DaemonSet [] Returns # DaemonSet [] Inherited from # KubeObjectStore.getItems getStatuses # \u25b8 getStatuses ( daemonSets? ): Object Parameters # Name Type daemonSets? DaemonSet [] Returns # Object Name Type failed number pending number running number getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item DaemonSet Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? DaemonSet [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < DaemonSet > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | DaemonSet []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | DaemonSet []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < DaemonSet > Parameters # Name Type resourcePath string Returns # Promise < DaemonSet > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | DaemonSet > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < DaemonSet []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < DaemonSet []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): DaemonSet [] Parameters # Name Type partialItems DaemonSet [] \u00abdestructured\u00bb MergeItemsOptions Returns # DaemonSet [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < DaemonSet > Parameters # Name Type item DaemonSet patch Patch Returns # Promise < DaemonSet > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): DaemonSet [] Parameters # Name Type items DaemonSet [] Returns # DaemonSet [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | DaemonSet []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | DaemonSet []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item DaemonSet Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item DaemonSet request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items DaemonSet [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item DaemonSet Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # DaemonSet [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item DaemonSet Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? DaemonSet [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item DaemonSet Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < DaemonSet > Parameters # Name Type item DaemonSet data PartialObjectDeep < DaemonSet > Returns # Promise < DaemonSet > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < DaemonSet > Parameters # Name Type item DaemonSet request () => Promise < DaemonSet > Returns # Promise < DaemonSet > Inherited from # KubeObjectStore.updateItem","title":"Class: DaemonSetStore"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#class-daemonsetstore","text":"Renderer . K8sApi .DaemonSetStore","title":"Class: DaemonSetStore"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#hierarchy","text":"KubeObjectStore < DaemonSet , DaemonSetApi > \u21b3 DaemonSetStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#constructor","text":"\u2022 new DaemonSetStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#api","text":"\u2022 Readonly api : DaemonSetApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : DaemonSet ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#dependencies","text":"\u2022 Protected Readonly dependencies : DaemonSetStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , DaemonSetStatus , DaemonSetSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#items","text":"\u2022 items : IObservableArray < DaemonSet >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#iterator","text":"\u25b8 [iterator] (): Generator < DaemonSet , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#create","text":"\u25b8 create ( params , data? ): Promise < DaemonSet >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | DaemonSet >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): DaemonSet []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): DaemonSet []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbyid","text":"\u25b8 getById ( id ): undefined | DaemonSet","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): DaemonSet []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | DaemonSet","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | DaemonSet","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getchildpods","text":"\u25b8 getChildPods ( daemonSet ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getitems","text":"\u25b8 getItems (): DaemonSet []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getstatuses","text":"\u25b8 getStatuses ( daemonSets? ): Object","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#load","text":"\u25b8 load ( params ): Promise < DaemonSet >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | DaemonSet []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < DaemonSet >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | DaemonSet >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < DaemonSet []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): DaemonSet []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < DaemonSet >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): DaemonSet []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | DaemonSet []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#update","text":"\u25b8 update ( item , data ): Promise < DaemonSet >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < DaemonSet >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/","text":"Class: DeploymentStore # Renderer . K8sApi .DeploymentStore Hierarchy # KubeObjectStore < Deployment , DeploymentApi > \u21b3 DeploymentStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new DeploymentStore ( dependencies , api , opts? ) Parameters # Name Type dependencies DeploymentStoreDependencies api DeploymentApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : DeploymentApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Deployment ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Deployment Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : DeploymentStoreDependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Deployment > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Deployment , void , undefined > Returns # Generator < Deployment , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Deployment > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Deployment > Returns # Promise < Deployment > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Deployment > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Deployment > Returns # Promise < null | Deployment > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Deployment [] Parameters # Name Type items Deployment [] Returns # Deployment [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Deployment [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Deployment [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Deployment Parameters # Name Type id string Returns # undefined | Deployment Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Deployment [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Deployment [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Deployment Parameters # Name Type name string namespace? string Returns # undefined | Deployment Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Deployment Parameters # Name Type path string Returns # undefined | Deployment Inherited from # KubeObjectStore.getByPath getChildPods # \u25b8 getChildPods ( deployment ): Pod [] Parameters # Name Type deployment Deployment Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Deployment [] Returns # Deployment [] Inherited from # KubeObjectStore.getItems getStatuses # \u25b8 getStatuses ( deployments ): DeploymentStatuses Parameters # Name Type deployments Deployment [] Returns # DeploymentStatuses \u25b8 getStatuses ( deployments ): DeploymentStatuses Deprecated Parameters # Name Type deployments undefined | Deployment [] Returns # DeploymentStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Deployment Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Deployment [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Deployment > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Deployment > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Deployment []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Deployment []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Deployment > Parameters # Name Type resourcePath string Returns # Promise < Deployment > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Deployment > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Deployment > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Deployment []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Deployment []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Deployment [] Parameters # Name Type partialItems Deployment [] \u00abdestructured\u00bb MergeItemsOptions Returns # Deployment [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Deployment > Parameters # Name Type item Deployment patch Patch Returns # Promise < Deployment > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Deployment [] Parameters # Name Type items Deployment [] Returns # Deployment [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Deployment []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Deployment []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Deployment Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Deployment request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Deployment [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Deployment Returns # void Inherited from # KubeObjectStore.select sortItems # \u25b8 Protected sortItems ( items ): Deployment [] Parameters # Name Type items Deployment [] Returns # Deployment [] Overrides # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Deployment Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Deployment [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Deployment Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Deployment > Parameters # Name Type item Deployment data PartialObjectDeep < Deployment > Returns # Promise < Deployment > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Deployment > Parameters # Name Type item Deployment request () => Promise < Deployment > Returns # Promise < Deployment > Inherited from # KubeObjectStore.updateItem","title":"Class: DeploymentStore"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#class-deploymentstore","text":"Renderer . K8sApi .DeploymentStore","title":"Class: DeploymentStore"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#hierarchy","text":"KubeObjectStore < Deployment , DeploymentApi > \u21b3 DeploymentStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#constructor","text":"\u2022 new DeploymentStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#api","text":"\u2022 Readonly api : DeploymentApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Deployment ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#dependencies","text":"\u2022 Protected Readonly dependencies : DeploymentStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#items","text":"\u2022 items : IObservableArray < Deployment >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#iterator","text":"\u25b8 [iterator] (): Generator < Deployment , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#create","text":"\u25b8 create ( params , data? ): Promise < Deployment >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Deployment >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Deployment []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Deployment []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Deployment","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Deployment []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Deployment","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Deployment","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getchildpods","text":"\u25b8 getChildPods ( deployment ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getitems","text":"\u25b8 getItems (): Deployment []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getstatuses","text":"\u25b8 getStatuses ( deployments ): DeploymentStatuses","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#load","text":"\u25b8 load ( params ): Promise < Deployment >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Deployment []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Deployment >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Deployment >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Deployment []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Deployment []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Deployment >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Deployment []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Deployment []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#sortitems","text":"\u25b8 Protected sortItems ( items ): Deployment []","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#update","text":"\u25b8 update ( item , data ): Promise < Deployment >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Deployment >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/","text":"Class: EndpointStore # Renderer . K8sApi .EndpointStore Hierarchy # KubeObjectStore < Endpoint , EndpointsApi , EndpointsData > \u21b3 EndpointStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new EndpointStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api EndpointsApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : EndpointsApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Endpoint ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Endpoint Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < EndpointsData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Endpoint > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Endpoint , void , undefined > Returns # Generator < Endpoint , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Endpoint > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Endpoint > Returns # Promise < Endpoint > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Endpoint > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Endpoint > Returns # Promise < null | Endpoint > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Endpoint [] Parameters # Name Type items Endpoint [] Returns # Endpoint [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Endpoint [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Endpoint [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Endpoint Parameters # Name Type id string Returns # undefined | Endpoint Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Endpoint [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Endpoint [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Endpoint Parameters # Name Type name string namespace? string Returns # undefined | Endpoint Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Endpoint Parameters # Name Type path string Returns # undefined | Endpoint Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Endpoint [] Returns # Endpoint [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Endpoint Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Endpoint [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Endpoint > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Endpoint > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Endpoint []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Endpoint []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Endpoint > Parameters # Name Type resourcePath string Returns # Promise < Endpoint > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Endpoint > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Endpoint > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Endpoint []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Endpoint []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Endpoint [] Parameters # Name Type partialItems Endpoint [] \u00abdestructured\u00bb MergeItemsOptions Returns # Endpoint [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Endpoint > Parameters # Name Type item Endpoint patch Patch Returns # Promise < Endpoint > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Endpoint [] Parameters # Name Type items Endpoint [] Returns # Endpoint [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Endpoint []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Endpoint []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Endpoint Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Endpoint request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Endpoint [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Endpoint Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Endpoint [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Endpoint Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Endpoint [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Endpoint Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Endpoint > Parameters # Name Type item Endpoint data PartialObjectDeep < Endpoint > Returns # Promise < Endpoint > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Endpoint > Parameters # Name Type item Endpoint request () => Promise < Endpoint > Returns # Promise < Endpoint > Inherited from # KubeObjectStore.updateItem","title":"Class: EndpointStore"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#class-endpointstore","text":"Renderer . K8sApi .EndpointStore","title":"Class: EndpointStore"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#hierarchy","text":"KubeObjectStore < Endpoint , EndpointsApi , EndpointsData > \u21b3 EndpointStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#constructor","text":"\u2022 new EndpointStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#api","text":"\u2022 Readonly api : EndpointsApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Endpoint ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < EndpointsData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#items","text":"\u2022 items : IObservableArray < Endpoint >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#iterator","text":"\u25b8 [iterator] (): Generator < Endpoint , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#create","text":"\u25b8 create ( params , data? ): Promise < Endpoint >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Endpoint >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Endpoint []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Endpoint []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Endpoint","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Endpoint []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Endpoint","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Endpoint","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getitems","text":"\u25b8 getItems (): Endpoint []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#load","text":"\u25b8 load ( params ): Promise < Endpoint >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Endpoint []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Endpoint >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Endpoint >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Endpoint []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Endpoint []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Endpoint >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Endpoint []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Endpoint []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#update","text":"\u25b8 update ( item , data ): Promise < Endpoint >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Endpoint >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/","text":"Class: EventStore # Renderer . K8sApi .EventStore Hierarchy # KubeObjectStore < KubeEvent , KubeEventApi > \u21b3 EventStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getEventsByObject getIndexById getItems getTotalCount getWarnings getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new EventStore ( dependencies , api , opts? ) Parameters # Name Type dependencies EventStoreDependencies api KubeEventApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : KubeEventApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : KubeEvent ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item KubeEvent Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : EventStoreDependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeEventData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < KubeEvent > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < KubeEvent , void , undefined > Returns # Generator < KubeEvent , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater (): void Returns # void Overrides # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < KubeEvent > Returns # Promise < KubeEvent > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < KubeEvent > Returns # Promise < null | KubeEvent > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): KubeEvent [] Parameters # Name Type items KubeEvent [] Returns # KubeEvent [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): KubeEvent [] Parameters # Name Type namespace string | string [] strict? boolean Returns # KubeEvent [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | KubeEvent Parameters # Name Type id string Returns # undefined | KubeEvent Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): KubeEvent [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # KubeEvent [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | KubeEvent Parameters # Name Type name string namespace? string Returns # undefined | KubeEvent Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | KubeEvent Parameters # Name Type path string Returns # undefined | KubeEvent Inherited from # KubeObjectStore.getByPath getEventsByObject # \u25b8 getEventsByObject ( obj ): KubeEvent [] Parameters # Name Type obj KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # KubeEvent [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): KubeEvent [] Returns # KubeEvent [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount getWarnings # \u25b8 getWarnings (): KubeEvent [] Returns # KubeEvent [] getWarningsCount # \u25b8 getWarningsCount (): number Returns # number isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item KubeEvent Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? KubeEvent [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < KubeEvent > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | KubeEvent []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | KubeEvent []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < KubeEvent > Parameters # Name Type resourcePath string Returns # Promise < KubeEvent > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | KubeEvent > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < KubeEvent []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < KubeEvent []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): KubeEvent [] Parameters # Name Type partialItems KubeEvent [] \u00abdestructured\u00bb MergeItemsOptions Returns # KubeEvent [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < KubeEvent > Parameters # Name Type item KubeEvent patch Patch Returns # Promise < KubeEvent > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): KubeEvent [] Parameters # Name Type items KubeEvent [] Returns # KubeEvent [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | KubeEvent []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | KubeEvent []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item KubeEvent Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item KubeEvent request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items KubeEvent [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item KubeEvent Returns # void Inherited from # KubeObjectStore.select sortItems # \u25b8 Protected sortItems ( items ): KubeEvent [] Parameters # Name Type items KubeEvent [] Returns # KubeEvent [] Overrides # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item KubeEvent Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? KubeEvent [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item KubeEvent Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < KubeEvent > Parameters # Name Type item KubeEvent data PartialObjectDeep < KubeEvent > Returns # Promise < KubeEvent > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < KubeEvent > Parameters # Name Type item KubeEvent request () => Promise < KubeEvent > Returns # Promise < KubeEvent > Inherited from # KubeObjectStore.updateItem","title":"Class: EventStore"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#class-eventstore","text":"Renderer . K8sApi .EventStore","title":"Class: EventStore"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#hierarchy","text":"KubeObjectStore < KubeEvent , KubeEventApi > \u21b3 EventStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getEventsByObject getIndexById getItems getTotalCount getWarnings getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#constructor","text":"\u2022 new EventStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#api","text":"\u2022 Readonly api : KubeEventApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : KubeEvent ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#dependencies","text":"\u2022 Protected Readonly dependencies : EventStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeEventData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#items","text":"\u2022 items : IObservableArray < KubeEvent >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#iterator","text":"\u25b8 [iterator] (): Generator < KubeEvent , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater (): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#create","text":"\u25b8 create ( params , data? ): Promise < KubeEvent >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | KubeEvent >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): KubeEvent []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): KubeEvent []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbyid","text":"\u25b8 getById ( id ): undefined | KubeEvent","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): KubeEvent []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | KubeEvent","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | KubeEvent","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#geteventsbyobject","text":"\u25b8 getEventsByObject ( obj ): KubeEvent []","title":"getEventsByObject"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getitems","text":"\u25b8 getItems (): KubeEvent []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getwarnings","text":"\u25b8 getWarnings (): KubeEvent []","title":"getWarnings"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getwarningscount","text":"\u25b8 getWarningsCount (): number","title":"getWarningsCount"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#load","text":"\u25b8 load ( params ): Promise < KubeEvent >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | KubeEvent []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < KubeEvent >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | KubeEvent >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < KubeEvent []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): KubeEvent []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < KubeEvent >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): KubeEvent []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | KubeEvent []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#sortitems","text":"\u25b8 Protected sortItems ( items ): KubeEvent []","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#update","text":"\u25b8 update ( item , data ): Promise < KubeEvent >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < KubeEvent >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/","text":"Class: HPAStore # Renderer . K8sApi .HPAStore Hierarchy # KubeObjectStore < HorizontalPodAutoscaler , HorizontalPodAutoscalerApi > \u21b3 HPAStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new HPAStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api HorizontalPodAutoscalerApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : HorizontalPodAutoscalerApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : HorizontalPodAutoscaler ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item HorizontalPodAutoscaler Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , HorizontalPodAutoscalerStatus , HorizontalPodAutoscalerSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < HorizontalPodAutoscaler > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < HorizontalPodAutoscaler , void , undefined > Returns # Generator < HorizontalPodAutoscaler , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < HorizontalPodAutoscaler > Returns # Promise < null | HorizontalPodAutoscaler > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): HorizontalPodAutoscaler [] Parameters # Name Type items HorizontalPodAutoscaler [] Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): HorizontalPodAutoscaler [] Parameters # Name Type namespace string | string [] strict? boolean Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | HorizontalPodAutoscaler Parameters # Name Type id string Returns # undefined | HorizontalPodAutoscaler Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): HorizontalPodAutoscaler [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | HorizontalPodAutoscaler Parameters # Name Type name string namespace? string Returns # undefined | HorizontalPodAutoscaler Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | HorizontalPodAutoscaler Parameters # Name Type path string Returns # undefined | HorizontalPodAutoscaler Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): HorizontalPodAutoscaler [] Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item HorizontalPodAutoscaler Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? HorizontalPodAutoscaler [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | HorizontalPodAutoscaler []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | HorizontalPodAutoscaler []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < HorizontalPodAutoscaler > Parameters # Name Type resourcePath string Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | HorizontalPodAutoscaler > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < HorizontalPodAutoscaler []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < HorizontalPodAutoscaler []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): HorizontalPodAutoscaler [] Parameters # Name Type partialItems HorizontalPodAutoscaler [] \u00abdestructured\u00bb MergeItemsOptions Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < HorizontalPodAutoscaler > Parameters # Name Type item HorizontalPodAutoscaler patch Patch Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): HorizontalPodAutoscaler [] Parameters # Name Type items HorizontalPodAutoscaler [] Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | HorizontalPodAutoscaler []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | HorizontalPodAutoscaler []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item HorizontalPodAutoscaler Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item HorizontalPodAutoscaler request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items HorizontalPodAutoscaler [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item HorizontalPodAutoscaler Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item HorizontalPodAutoscaler Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? HorizontalPodAutoscaler [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item HorizontalPodAutoscaler Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < HorizontalPodAutoscaler > Parameters # Name Type item HorizontalPodAutoscaler data PartialObjectDeep < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < HorizontalPodAutoscaler > Parameters # Name Type item HorizontalPodAutoscaler request () => Promise < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore.updateItem","title":"Class: HPAStore"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#class-hpastore","text":"Renderer . K8sApi .HPAStore","title":"Class: HPAStore"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#hierarchy","text":"KubeObjectStore < HorizontalPodAutoscaler , HorizontalPodAutoscalerApi > \u21b3 HPAStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#constructor","text":"\u2022 new HPAStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#api","text":"\u2022 Readonly api : HorizontalPodAutoscalerApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : HorizontalPodAutoscaler ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , HorizontalPodAutoscalerStatus , HorizontalPodAutoscalerSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#items","text":"\u2022 items : IObservableArray < HorizontalPodAutoscaler >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#iterator","text":"\u25b8 [iterator] (): Generator < HorizontalPodAutoscaler , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#create","text":"\u25b8 create ( params , data? ): Promise < HorizontalPodAutoscaler >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | HorizontalPodAutoscaler >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): HorizontalPodAutoscaler []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): HorizontalPodAutoscaler []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbyid","text":"\u25b8 getById ( id ): undefined | HorizontalPodAutoscaler","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): HorizontalPodAutoscaler []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | HorizontalPodAutoscaler","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | HorizontalPodAutoscaler","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getitems","text":"\u25b8 getItems (): HorizontalPodAutoscaler []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#load","text":"\u25b8 load ( params ): Promise < HorizontalPodAutoscaler >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | HorizontalPodAutoscaler []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < HorizontalPodAutoscaler >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | HorizontalPodAutoscaler >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < HorizontalPodAutoscaler []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): HorizontalPodAutoscaler []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < HorizontalPodAutoscaler >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): HorizontalPodAutoscaler []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | HorizontalPodAutoscaler []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#update","text":"\u25b8 update ( item , data ): Promise < HorizontalPodAutoscaler >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < HorizontalPodAutoscaler >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/","text":"Class: IngressClassStore # Renderer . K8sApi .IngressClassStore Hierarchy # KubeObjectStore < IngressClass , IngressClassApi > \u21b3 IngressClassStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new IngressClassStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api IngressClassApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : IngressClassApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : IngressClass ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item IngressClass Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < IngressClassMetadata , IngressClassStatus , IngressClassSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < IngressClass > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < IngressClass , void , undefined > Returns # Generator < IngressClass , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < IngressClass > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < IngressClass > Returns # Promise < IngressClass > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | IngressClass > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < IngressClass > Returns # Promise < null | IngressClass > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): IngressClass [] Parameters # Name Type items IngressClass [] Returns # IngressClass [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): IngressClass [] Parameters # Name Type namespace string | string [] strict? boolean Returns # IngressClass [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | IngressClass Parameters # Name Type id string Returns # undefined | IngressClass Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): IngressClass [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # IngressClass [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | IngressClass Parameters # Name Type name string namespace? string Returns # undefined | IngressClass Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | IngressClass Parameters # Name Type path string Returns # undefined | IngressClass Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): IngressClass [] Returns # IngressClass [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item IngressClass Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? IngressClass [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < IngressClass > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < IngressClass > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | IngressClass []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | IngressClass []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < IngressClass > Parameters # Name Type resourcePath string Returns # Promise < IngressClass > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | IngressClass > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | IngressClass > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < IngressClass []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < IngressClass []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): IngressClass [] Parameters # Name Type partialItems IngressClass [] \u00abdestructured\u00bb MergeItemsOptions Returns # IngressClass [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < IngressClass > Parameters # Name Type item IngressClass patch Patch Returns # Promise < IngressClass > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): IngressClass [] Parameters # Name Type items IngressClass [] Returns # IngressClass [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | IngressClass []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | IngressClass []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item IngressClass Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item IngressClass request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items IngressClass [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item IngressClass Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # IngressClass [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item IngressClass Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? IngressClass [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item IngressClass Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < IngressClass > Parameters # Name Type item IngressClass data PartialObjectDeep < IngressClass > Returns # Promise < IngressClass > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < IngressClass > Parameters # Name Type item IngressClass request () => Promise < IngressClass > Returns # Promise < IngressClass > Inherited from # KubeObjectStore.updateItem","title":"Class: IngressClassStore"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#class-ingressclassstore","text":"Renderer . K8sApi .IngressClassStore","title":"Class: IngressClassStore"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#hierarchy","text":"KubeObjectStore < IngressClass , IngressClassApi > \u21b3 IngressClassStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#constructor","text":"\u2022 new IngressClassStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#api","text":"\u2022 Readonly api : IngressClassApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : IngressClass ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < IngressClassMetadata , IngressClassStatus , IngressClassSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#items","text":"\u2022 items : IObservableArray < IngressClass >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#iterator","text":"\u25b8 [iterator] (): Generator < IngressClass , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#create","text":"\u25b8 create ( params , data? ): Promise < IngressClass >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | IngressClass >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): IngressClass []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): IngressClass []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbyid","text":"\u25b8 getById ( id ): undefined | IngressClass","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): IngressClass []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | IngressClass","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | IngressClass","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#getitems","text":"\u25b8 getItems (): IngressClass []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#load","text":"\u25b8 load ( params ): Promise < IngressClass >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | IngressClass []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < IngressClass >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | IngressClass >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < IngressClass []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): IngressClass []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < IngressClass >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): IngressClass []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | IngressClass []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#update","text":"\u25b8 update ( item , data ): Promise < IngressClass >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressClassStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < IngressClass >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/","text":"Class: IngressStore # Renderer . K8sApi .IngressStore Hierarchy # KubeObjectStore < Ingress , IngressApi > \u21b3 IngressStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new IngressStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api IngressApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : IngressApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Ingress ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Ingress Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , IngressStatus , IngressSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Ingress > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Ingress , void , undefined > Returns # Generator < Ingress , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Ingress > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Ingress > Returns # Promise < Ingress > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Ingress > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Ingress > Returns # Promise < null | Ingress > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Ingress [] Parameters # Name Type items Ingress [] Returns # Ingress [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Ingress [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Ingress [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Ingress Parameters # Name Type id string Returns # undefined | Ingress Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Ingress [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Ingress [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Ingress Parameters # Name Type name string namespace? string Returns # undefined | Ingress Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Ingress Parameters # Name Type path string Returns # undefined | Ingress Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Ingress [] Returns # Ingress [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Ingress Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Ingress [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Ingress > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Ingress > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Ingress []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Ingress []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Ingress > Parameters # Name Type resourcePath string Returns # Promise < Ingress > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Ingress > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Ingress > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Ingress []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Ingress []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Ingress [] Parameters # Name Type partialItems Ingress [] \u00abdestructured\u00bb MergeItemsOptions Returns # Ingress [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Ingress > Parameters # Name Type item Ingress patch Patch Returns # Promise < Ingress > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Ingress [] Parameters # Name Type items Ingress [] Returns # Ingress [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Ingress []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Ingress []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Ingress Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Ingress request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Ingress [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Ingress Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Ingress [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Ingress Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Ingress [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Ingress Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Ingress > Parameters # Name Type item Ingress data PartialObjectDeep < Ingress > Returns # Promise < Ingress > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Ingress > Parameters # Name Type item Ingress request () => Promise < Ingress > Returns # Promise < Ingress > Inherited from # KubeObjectStore.updateItem","title":"Class: IngressStore"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#class-ingressstore","text":"Renderer . K8sApi .IngressStore","title":"Class: IngressStore"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#hierarchy","text":"KubeObjectStore < Ingress , IngressApi > \u21b3 IngressStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#constructor","text":"\u2022 new IngressStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#api","text":"\u2022 Readonly api : IngressApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Ingress ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , IngressStatus , IngressSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#items","text":"\u2022 items : IObservableArray < Ingress >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#iterator","text":"\u25b8 [iterator] (): Generator < Ingress , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#create","text":"\u25b8 create ( params , data? ): Promise < Ingress >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Ingress >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Ingress []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Ingress []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Ingress","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Ingress []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Ingress","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Ingress","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getitems","text":"\u25b8 getItems (): Ingress []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#load","text":"\u25b8 load ( params ): Promise < Ingress >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Ingress []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Ingress >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Ingress >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Ingress []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Ingress []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Ingress >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Ingress []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Ingress []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#update","text":"\u25b8 update ( item , data ): Promise < Ingress >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Ingress >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/","text":"Class: JobStore # Renderer . K8sApi .JobStore Hierarchy # KubeObjectStore < Job , JobApi > \u21b3 JobStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getJobsByOwner getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new JobStore ( dependencies , api , opts? ) Parameters # Name Type dependencies Dependencies api JobApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : JobApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Job ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Job Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : Dependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , JobStatus , JobSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Job > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Job , void , undefined > Returns # Generator < Job , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Job > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Job > Returns # Promise < Job > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Job > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Job > Returns # Promise < null | Job > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Job [] Parameters # Name Type items Job [] Returns # Job [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Job [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Job [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Job Parameters # Name Type id string Returns # undefined | Job Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Job [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Job [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Job Parameters # Name Type name string namespace? string Returns # undefined | Job Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Job Parameters # Name Type path string Returns # undefined | Job Inherited from # KubeObjectStore.getByPath getChildPods # \u25b8 getChildPods ( job ): Pod [] Parameters # Name Type job Job Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Job [] Returns # Job [] Inherited from # KubeObjectStore.getItems getJobsByOwner # \u25b8 getJobsByOwner ( cronJob ): Job [] Parameters # Name Type cronJob CronJob Returns # Job [] getStatuses # \u25b8 getStatuses ( jobs? ): Object Parameters # Name Type jobs? Job [] Returns # Object Name Type failed number pending number running number succeeded number getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Job Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Job [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Job > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Job > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Job []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Job []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Job > Parameters # Name Type resourcePath string Returns # Promise < Job > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Job > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Job > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Job []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Job []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Job [] Parameters # Name Type partialItems Job [] \u00abdestructured\u00bb MergeItemsOptions Returns # Job [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Job > Parameters # Name Type item Job patch Patch Returns # Promise < Job > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Job [] Parameters # Name Type items Job [] Returns # Job [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Job []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Job []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Job Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Job request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Job [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Job Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Job [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Job Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Job [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Job Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Job > Parameters # Name Type item Job data PartialObjectDeep < Job > Returns # Promise < Job > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Job > Parameters # Name Type item Job request () => Promise < Job > Returns # Promise < Job > Inherited from # KubeObjectStore.updateItem","title":"Class: JobStore"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#class-jobstore","text":"Renderer . K8sApi .JobStore","title":"Class: JobStore"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#hierarchy","text":"KubeObjectStore < Job , JobApi > \u21b3 JobStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getJobsByOwner getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#constructor","text":"\u2022 new JobStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#api","text":"\u2022 Readonly api : JobApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Job ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#dependencies","text":"\u2022 Protected Readonly dependencies : Dependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , JobStatus , JobSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#items","text":"\u2022 items : IObservableArray < Job >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#iterator","text":"\u25b8 [iterator] (): Generator < Job , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#create","text":"\u25b8 create ( params , data? ): Promise < Job >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Job >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Job []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Job []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Job","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Job []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Job","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Job","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getchildpods","text":"\u25b8 getChildPods ( job ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getitems","text":"\u25b8 getItems (): Job []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getjobsbyowner","text":"\u25b8 getJobsByOwner ( cronJob ): Job []","title":"getJobsByOwner"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getstatuses","text":"\u25b8 getStatuses ( jobs? ): Object","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#load","text":"\u25b8 load ( params ): Promise < Job >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Job []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Job >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Job >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Job []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Job []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Job >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Job []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Job []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#update","text":"\u25b8 update ( item , data ): Promise < Job >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Job >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/","text":"Class: KubeObjectStore # Renderer . K8sApi .KubeObjectStore Type parameters # Name Type K extends KubeObject = KubeObject A extends InternalKubeApi < K , D > = InternalKubeApi < K , KubeJsonApiDataFor < K >> D extends KubeJsonApiDataFor < K > = KubeApiDataFrom < K , A > Hierarchy # KubeObjectStore < K , A , D > \u21b3 KubeObjectStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds context Accessors # context contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new KubeObjectStore < K , A , D >( api , opts? ) Type parameters # Name Type 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 > Parameters # Name Type api A opts? KubeObjectStoreOptions Overrides # InternalKubeObjectStore.constructor \u2022 new KubeObjectStore < K , A , D >() Deprecated Supply API instance through constructor Type parameters # Name Type 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 > Overrides # InternalKubeObjectStore.constructor Properties # api # \u2022 Readonly api : A Inherited from # InternalKubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # InternalKubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : K ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item K Returns # string Inherited from # InternalKubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # InternalKubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < D >> Inherited from # InternalKubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # InternalKubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # InternalKubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # InternalKubeObjectStore.isLoading items # \u2022 items : IObservableArray < K > Inherited from # InternalKubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # InternalKubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # InternalKubeObjectStore.selectedItemsIds context # \u25aa Static Readonly context : Object Deprecated This is no longer used and shouldn't have been every really used Type declaration # Name Type get () => ClusterContext set ( ctx : ClusterContext ) => void Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # InternalKubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # InternalKubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # InternalKubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < K , void , undefined > Returns # Generator < K , void , undefined > Inherited from # InternalKubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # InternalKubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string data? PartialDeep < K > Returns # Promise < K > Inherited from # InternalKubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | K > Parameters # Name Type params Object params.name string params.namespace? string data? PartialDeep < K > Returns # Promise < null | K > Inherited from # InternalKubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): K [] Parameters # Name Type items K [] Returns # K [] Inherited from # InternalKubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): K [] Parameters # Name Type namespace string | string [] strict? boolean Returns # K [] Inherited from # InternalKubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | K Parameters # Name Type id string Returns # undefined | K Inherited from # InternalKubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): K [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # K [] Inherited from # InternalKubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | K Parameters # Name Type name string namespace? string Returns # undefined | K Inherited from # InternalKubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | K Parameters # Name Type path string Returns # undefined | K Inherited from # InternalKubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # InternalKubeObjectStore.getIndexById getItems # \u25b8 getItems (): K [] Returns # K [] Inherited from # InternalKubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # InternalKubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item K Returns # boolean Inherited from # InternalKubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? K [] Returns # boolean Inherited from # InternalKubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < K > Inherited from # InternalKubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | K []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | K []> Inherited from # InternalKubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < K > Parameters # Name Type resourcePath string Returns # Promise < K > Inherited from # InternalKubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | K > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | K > Inherited from # InternalKubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < K []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < K []> Inherited from # InternalKubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): K [] Parameters # Name Type partialItems K [] \u00abdestructured\u00bb MergeItemsOptions Returns # K [] Inherited from # InternalKubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < K > Parameters # Name Type item K patch Patch Returns # Promise < K > Inherited from # InternalKubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): K [] Parameters # Name Type items K [] Returns # K [] Inherited from # InternalKubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | K []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | K []> Inherited from # InternalKubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item K Returns # Promise < void > Inherited from # InternalKubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item K request () => Promise < any > Returns # Promise < void > Inherited from # InternalKubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items K [] Returns # Promise < void > Inherited from # InternalKubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # InternalKubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # InternalKubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # InternalKubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # InternalKubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item K Returns # void Inherited from # InternalKubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # K [] Inherited from # InternalKubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # InternalKubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item K Returns # void Inherited from # InternalKubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? K [] Returns # void Inherited from # InternalKubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item K Returns # void Inherited from # InternalKubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < K > Parameters # Name Type item K data PartialDeep < K > Returns # Promise < K > Inherited from # InternalKubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # InternalKubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < K > Parameters # Name Type item K request () => Promise < K > Returns # Promise < K > Inherited from # InternalKubeObjectStore.updateItem","title":"Class: KubeObjectStore"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#class-kubeobjectstorek-a-d","text":"Renderer . K8sApi .KubeObjectStore","title":"Class: KubeObjectStore<K, A, D>"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#type-parameters","text":"Name Type K extends KubeObject = KubeObject A extends InternalKubeApi < K , D > = InternalKubeApi < K , KubeJsonApiDataFor < K >> D extends KubeJsonApiDataFor < K > = KubeApiDataFrom < K , A >","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#hierarchy","text":"KubeObjectStore < K , A , D > \u21b3 KubeObjectStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds context","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#accessors","text":"context contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#constructor","text":"\u2022 new KubeObjectStore < K , A , D >( api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#api","text":"\u2022 Readonly api : A","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : K ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < D >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#items","text":"\u2022 items : IObservableArray < K >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#context","text":"\u25aa Static Readonly context : Object Deprecated This is no longer used and shouldn't have been every really used","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#context_1","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#iterator","text":"\u25b8 [iterator] (): Generator < K , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#create","text":"\u25b8 create ( params , data? ): Promise < K >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | K >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): K []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): K []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getbyid","text":"\u25b8 getById ( id ): undefined | K","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): K []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | K","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | K","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getitems","text":"\u25b8 getItems (): K []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#load","text":"\u25b8 load ( params ): Promise < K >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | K []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < K >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | K >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < K []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): K []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < K >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): K []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | K []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#update","text":"\u25b8 update ( item , data ): Promise < K >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < K >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/","text":"Class: LimitRangesStore # Renderer . K8sApi .LimitRangesStore Hierarchy # KubeObjectStore < LimitRange , LimitRangeApi > \u21b3 LimitRangesStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new LimitRangesStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api LimitRangeApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : LimitRangeApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : LimitRange ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item LimitRange Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , void , LimitRangeSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < LimitRange > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < LimitRange , void , undefined > Returns # Generator < LimitRange , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < LimitRange > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < LimitRange > Returns # Promise < LimitRange > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | LimitRange > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < LimitRange > Returns # Promise < null | LimitRange > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): LimitRange [] Parameters # Name Type items LimitRange [] Returns # LimitRange [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): LimitRange [] Parameters # Name Type namespace string | string [] strict? boolean Returns # LimitRange [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | LimitRange Parameters # Name Type id string Returns # undefined | LimitRange Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): LimitRange [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # LimitRange [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | LimitRange Parameters # Name Type name string namespace? string Returns # undefined | LimitRange Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | LimitRange Parameters # Name Type path string Returns # undefined | LimitRange Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): LimitRange [] Returns # LimitRange [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item LimitRange Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? LimitRange [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < LimitRange > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < LimitRange > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | LimitRange []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | LimitRange []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < LimitRange > Parameters # Name Type resourcePath string Returns # Promise < LimitRange > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | LimitRange > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | LimitRange > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < LimitRange []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < LimitRange []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): LimitRange [] Parameters # Name Type partialItems LimitRange [] \u00abdestructured\u00bb MergeItemsOptions Returns # LimitRange [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < LimitRange > Parameters # Name Type item LimitRange patch Patch Returns # Promise < LimitRange > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): LimitRange [] Parameters # Name Type items LimitRange [] Returns # LimitRange [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | LimitRange []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | LimitRange []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item LimitRange Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item LimitRange request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items LimitRange [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item LimitRange Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # LimitRange [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item LimitRange Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? LimitRange [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item LimitRange Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < LimitRange > Parameters # Name Type item LimitRange data PartialObjectDeep < LimitRange > Returns # Promise < LimitRange > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < LimitRange > Parameters # Name Type item LimitRange request () => Promise < LimitRange > Returns # Promise < LimitRange > Inherited from # KubeObjectStore.updateItem","title":"Class: LimitRangesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#class-limitrangesstore","text":"Renderer . K8sApi .LimitRangesStore","title":"Class: LimitRangesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#hierarchy","text":"KubeObjectStore < LimitRange , LimitRangeApi > \u21b3 LimitRangesStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#constructor","text":"\u2022 new LimitRangesStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#api","text":"\u2022 Readonly api : LimitRangeApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : LimitRange ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , void , LimitRangeSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#items","text":"\u2022 items : IObservableArray < LimitRange >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#iterator","text":"\u25b8 [iterator] (): Generator < LimitRange , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#create","text":"\u25b8 create ( params , data? ): Promise < LimitRange >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | LimitRange >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): LimitRange []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): LimitRange []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbyid","text":"\u25b8 getById ( id ): undefined | LimitRange","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): LimitRange []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | LimitRange","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | LimitRange","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getitems","text":"\u25b8 getItems (): LimitRange []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#load","text":"\u25b8 load ( params ): Promise < LimitRange >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | LimitRange []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < LimitRange >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | LimitRange >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < LimitRange []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): LimitRange []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < LimitRange >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): LimitRange []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | LimitRange []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#update","text":"\u25b8 update ( item , data ): Promise < LimitRange >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < LimitRange >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/","text":"Class: NamespaceStore # Renderer . K8sApi .NamespaceStore Hierarchy # KubeObjectStore < Namespace , NamespaceApi > \u21b3 NamespaceStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectNamespaces selectedItemsIds Accessors # allowedNamespaces areAllSelectedImplicitly contextItems contextNamespaces hasAllContexts query selectedItems selectedNames Methods # [iterator] bindWatchEventsUpdater clearSelected create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getNamespaceTree getTotalCount hasContext isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems onContextChange patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select selectAll selectSingle sortItems subscribe toggleAll toggleContext toggleSelection toggleSelectionAll toggleSingle unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new NamespaceStore ( dependencies , api ) Parameters # Name Type dependencies Dependencies api NamespaceApi Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : NamespaceApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Namespace ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Namespace Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : Dependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , NamespaceStatus , NamespaceSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Namespace > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectNamespaces # \u2022 selectNamespaces : ( namespace : string | string []) => void Type declaration # \u25b8 ( namespace ): void Parameters # Name Type namespace string | string [] Returns # void selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # allowedNamespaces # \u2022 get allowedNamespaces (): string [] Returns # string [] areAllSelectedImplicitly # \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 Returns # boolean contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems contextNamespaces # \u2022 get contextNamespaces (): string [] The list of selected namespace names (for filtering) Returns # string [] hasAllContexts # \u2022 get hasAllContexts (): boolean Is true if all available namespaces are selected, otherwise false Returns # boolean query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems selectedNames # \u2022 get selectedNames (): Set < string > The set of select namespace names (for filtering) Returns # Set < string > Methods # [iterator] # \u25b8 [iterator] (): Generator < Namespace , void , undefined > Returns # Generator < Namespace , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater clearSelected # \u25b8 clearSelected ( namespaces? ): void Parameters # Name Type namespaces? string | string [] Returns # void create # \u25b8 create ( params , data? ): Promise < Namespace > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Namespace > Returns # Promise < Namespace > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Namespace > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Namespace > Returns # Promise < null | Namespace > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Namespace [] Parameters # Name Type items Namespace [] Returns # Namespace [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Namespace [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Namespace [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Namespace Parameters # Name Type id string Returns # undefined | Namespace Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Namespace [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Namespace [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Namespace Parameters # Name Type name string namespace? string Returns # undefined | Namespace Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Namespace Parameters # Name Type path string Returns # undefined | Namespace Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Namespace [] Returns # Namespace [] Inherited from # KubeObjectStore.getItems getNamespaceTree # \u25b8 getNamespaceTree ( root ): NamespaceTree Parameters # Name Type root Namespace Returns # NamespaceTree getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount hasContext # \u25b8 hasContext ( namespaces ): boolean Checks if namespace names are selected for filtering Parameters # Name Type Description namespaces string | string [] One or several names of namespaces to check if they are selected Returns # boolean true if all the provided names are selected isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Namespace Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Namespace [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Namespace > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Namespace > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Namespace []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Namespace []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Namespace > Parameters # Name Type resourcePath string Returns # Promise < Namespace > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Namespace > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Namespace > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( params ): Promise < Namespace []> Parameters # Name Type params KubeObjectStoreLoadingParams Returns # Promise < Namespace []> Overrides # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Namespace [] Parameters # Name Type partialItems Namespace [] \u00abdestructured\u00bb MergeItemsOptions Returns # Namespace [] Inherited from # KubeObjectStore.mergeItems onContextChange # \u25b8 onContextChange ( callback , opts? ): IReactionDisposer Parameters # Name Type callback ( namespaces : string []) => void opts? Object opts.fireImmediately? boolean Returns # IReactionDisposer patch # \u25b8 patch ( item , patch ): Promise < Namespace > Parameters # Name Type item Namespace patch Patch Returns # Promise < Namespace > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Namespace [] Parameters # Name Type items Namespace [] Returns # Namespace [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Namespace []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Namespace []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Namespace Returns # Promise < void > Overrides # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Namespace request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Namespace [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Namespace Returns # void Inherited from # KubeObjectStore.select selectAll # \u25b8 selectAll (): void Selects all available namespaces. Note: If new namespaces appear in the future those will be selected too Returns # void selectSingle # \u25b8 selectSingle ( namespace ): void Makes the given namespace the sole selected namespace Parameters # Name Type namespace string Returns # void sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Namespace [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe (): (... args : T ) => void Returns # fn \u25b8 < T >( ...args ): void A function that does nothing Type parameters # Name Type T extends any [] Parameters # Name Type ...args T Returns # void Overrides # KubeObjectStore.subscribe toggleAll # \u25b8 toggleAll ( selectAll? ): void This function selects all namespaces implicitly. NOTE: does not toggle any namespaces Deprecated Use NamespaceStore.selectAll instead. Parameters # Name Type Description selectAll? boolean NOT USED Returns # void toggleContext # \u25b8 toggleContext ( namespaces ): void Acts like toggleSingle but can work on several at a time Parameters # Name Type Description namespaces string | string [] One or many names of namespaces to select Returns # void toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Namespace Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Namespace [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll toggleSingle # \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. Parameters # Name Type Description namespace string The name of a namespace Returns # void unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Namespace Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Namespace > Parameters # Name Type item Namespace data PartialObjectDeep < Namespace > Returns # Promise < Namespace > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Namespace > Parameters # Name Type item Namespace request () => Promise < Namespace > Returns # Promise < Namespace > Inherited from # KubeObjectStore.updateItem","title":"Class: NamespaceStore"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#class-namespacestore","text":"Renderer . K8sApi .NamespaceStore","title":"Class: NamespaceStore"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hierarchy","text":"KubeObjectStore < Namespace , NamespaceApi > \u21b3 NamespaceStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectNamespaces selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#accessors","text":"allowedNamespaces areAllSelectedImplicitly contextItems contextNamespaces hasAllContexts query selectedItems selectedNames","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#methods","text":"[iterator] bindWatchEventsUpdater clearSelected create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getNamespaceTree getTotalCount hasContext isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems onContextChange patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select selectAll selectSingle sortItems subscribe toggleAll toggleContext toggleSelection toggleSelectionAll toggleSingle unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#constructor","text":"\u2022 new NamespaceStore ( dependencies , api )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#api","text":"\u2022 Readonly api : NamespaceApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Namespace ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#dependencies","text":"\u2022 Protected Readonly dependencies : Dependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , NamespaceStatus , NamespaceSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#items","text":"\u2022 items : IObservableArray < Namespace >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectnamespaces","text":"\u2022 selectNamespaces : ( namespace : string | string []) => void","title":"selectNamespaces"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#allowednamespaces","text":"\u2022 get allowedNamespaces (): string []","title":"allowedNamespaces"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#areallselectedimplicitly","text":"\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","title":"areAllSelectedImplicitly"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#contextnamespaces","text":"\u2022 get contextNamespaces (): string [] The list of selected namespace names (for filtering)","title":"contextNamespaces"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hasallcontexts","text":"\u2022 get hasAllContexts (): boolean Is true if all available namespaces are selected, otherwise false","title":"hasAllContexts"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectednames","text":"\u2022 get selectedNames (): Set < string > The set of select namespace names (for filtering)","title":"selectedNames"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#iterator","text":"\u25b8 [iterator] (): Generator < Namespace , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#clearselected","text":"\u25b8 clearSelected ( namespaces? ): void","title":"clearSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#create","text":"\u25b8 create ( params , data? ): Promise < Namespace >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Namespace >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Namespace []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Namespace []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Namespace","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Namespace []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Namespace","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Namespace","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getitems","text":"\u25b8 getItems (): Namespace []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getnamespacetree","text":"\u25b8 getNamespaceTree ( root ): NamespaceTree","title":"getNamespaceTree"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hascontext","text":"\u25b8 hasContext ( namespaces ): boolean Checks if namespace names are selected for filtering","title":"hasContext"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#load","text":"\u25b8 load ( params ): Promise < Namespace >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Namespace []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Namespace >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Namespace >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loaditems","text":"\u25b8 Protected loadItems ( params ): Promise < Namespace []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Namespace []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#oncontextchange","text":"\u25b8 onContextChange ( callback , opts? ): IReactionDisposer","title":"onContextChange"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Namespace >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Namespace []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Namespace []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectall","text":"\u25b8 selectAll (): void Selects all available namespaces. Note: If new namespaces appear in the future those will be selected too","title":"selectAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectsingle","text":"\u25b8 selectSingle ( namespace ): void Makes the given namespace the sole selected namespace","title":"selectSingle"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#sortitems","text":"\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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#subscribe","text":"\u25b8 subscribe (): (... args : T ) => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleall","text":"\u25b8 toggleAll ( selectAll? ): void This function selects all namespaces implicitly. NOTE: does not toggle any namespaces Deprecated Use NamespaceStore.selectAll instead.","title":"toggleAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#togglecontext","text":"\u25b8 toggleContext ( namespaces ): void Acts like toggleSingle but can work on several at a time","title":"toggleContext"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#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.","title":"toggleSingle"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#update","text":"\u25b8 update ( item , data ): Promise < Namespace >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Namespace >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/","text":"Class: NetworkPolicyStore # Renderer . K8sApi .NetworkPolicyStore Hierarchy # KubeObjectStore < NetworkPolicy , NetworkPolicyApi > \u21b3 NetworkPolicyStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new NetworkPolicyStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api NetworkPolicyApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : NetworkPolicyApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : NetworkPolicy ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item NetworkPolicy Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , void , NetworkPolicySpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < NetworkPolicy > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < NetworkPolicy , void , undefined > Returns # Generator < NetworkPolicy , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < NetworkPolicy > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < NetworkPolicy > Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | NetworkPolicy > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < NetworkPolicy > Returns # Promise < null | NetworkPolicy > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): NetworkPolicy [] Parameters # Name Type items NetworkPolicy [] Returns # NetworkPolicy [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): NetworkPolicy [] Parameters # Name Type namespace string | string [] strict? boolean Returns # NetworkPolicy [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | NetworkPolicy Parameters # Name Type id string Returns # undefined | NetworkPolicy Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): NetworkPolicy [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # NetworkPolicy [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | NetworkPolicy Parameters # Name Type name string namespace? string Returns # undefined | NetworkPolicy Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | NetworkPolicy Parameters # Name Type path string Returns # undefined | NetworkPolicy Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): NetworkPolicy [] Returns # NetworkPolicy [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item NetworkPolicy Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? NetworkPolicy [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < NetworkPolicy > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | NetworkPolicy []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | NetworkPolicy []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < NetworkPolicy > Parameters # Name Type resourcePath string Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | NetworkPolicy > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | NetworkPolicy > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < NetworkPolicy []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < NetworkPolicy []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): NetworkPolicy [] Parameters # Name Type partialItems NetworkPolicy [] \u00abdestructured\u00bb MergeItemsOptions Returns # NetworkPolicy [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < NetworkPolicy > Parameters # Name Type item NetworkPolicy patch Patch Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): NetworkPolicy [] Parameters # Name Type items NetworkPolicy [] Returns # NetworkPolicy [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | NetworkPolicy []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | NetworkPolicy []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item NetworkPolicy Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item NetworkPolicy request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items NetworkPolicy [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item NetworkPolicy Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # NetworkPolicy [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item NetworkPolicy Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? NetworkPolicy [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item NetworkPolicy Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < NetworkPolicy > Parameters # Name Type item NetworkPolicy data PartialObjectDeep < NetworkPolicy > Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < NetworkPolicy > Parameters # Name Type item NetworkPolicy request () => Promise < NetworkPolicy > Returns # Promise < NetworkPolicy > Inherited from # KubeObjectStore.updateItem","title":"Class: NetworkPolicyStore"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#class-networkpolicystore","text":"Renderer . K8sApi .NetworkPolicyStore","title":"Class: NetworkPolicyStore"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#hierarchy","text":"KubeObjectStore < NetworkPolicy , NetworkPolicyApi > \u21b3 NetworkPolicyStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#constructor","text":"\u2022 new NetworkPolicyStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#api","text":"\u2022 Readonly api : NetworkPolicyApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : NetworkPolicy ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , void , NetworkPolicySpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#items","text":"\u2022 items : IObservableArray < NetworkPolicy >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#iterator","text":"\u25b8 [iterator] (): Generator < NetworkPolicy , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#create","text":"\u25b8 create ( params , data? ): Promise < NetworkPolicy >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | NetworkPolicy >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): NetworkPolicy []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): NetworkPolicy []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbyid","text":"\u25b8 getById ( id ): undefined | NetworkPolicy","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): NetworkPolicy []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | NetworkPolicy","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | NetworkPolicy","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#getitems","text":"\u25b8 getItems (): NetworkPolicy []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#load","text":"\u25b8 load ( params ): Promise < NetworkPolicy >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | NetworkPolicy []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < NetworkPolicy >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | NetworkPolicy >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < NetworkPolicy []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): NetworkPolicy []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < NetworkPolicy >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): NetworkPolicy []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | NetworkPolicy []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#update","text":"\u25b8 update ( item , data ): Promise < NetworkPolicy >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < NetworkPolicy >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/","text":"Class: NodesStore # Renderer . K8sApi .NodesStore Hierarchy # KubeObjectStore < Node , NodeApi > \u21b3 NodesStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems masterNodes query selectedItems workerNodes Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new NodesStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api NodeApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : NodeApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Node ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Node Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , NodeStatus , NodeSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Node > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems masterNodes # \u2022 get masterNodes (): Node [] Returns # Node [] query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems workerNodes # \u2022 get workerNodes (): Node [] Returns # Node [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Node , void , undefined > Returns # Generator < Node , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Node > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Node > Returns # Promise < Node > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Node > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Node > Returns # Promise < null | Node > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Node [] Parameters # Name Type items Node [] Returns # Node [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Node [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Node [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Node Parameters # Name Type id string Returns # undefined | Node Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Node [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Node [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Node Parameters # Name Type name string namespace? string Returns # undefined | Node Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Node Parameters # Name Type path string Returns # undefined | Node Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Node [] Returns # Node [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount getWarningsCount # \u25b8 getWarningsCount (): number Returns # number isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Node Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Node [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Node > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Node > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Node []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Node []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Node > Parameters # Name Type resourcePath string Returns # Promise < Node > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Node > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Node > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Node []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Node []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Node [] Parameters # Name Type partialItems Node [] \u00abdestructured\u00bb MergeItemsOptions Returns # Node [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Node > Parameters # Name Type item Node patch Patch Returns # Promise < Node > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Node [] Parameters # Name Type items Node [] Returns # Node [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Node []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Node []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Node Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Node request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Node [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Node Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Node [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Node Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Node [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Node Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Node > Parameters # Name Type item Node data PartialObjectDeep < Node > Returns # Promise < Node > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Node > Parameters # Name Type item Node request () => Promise < Node > Returns # Promise < Node > Inherited from # KubeObjectStore.updateItem","title":"Class: NodesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#class-nodesstore","text":"Renderer . K8sApi .NodesStore","title":"Class: NodesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#hierarchy","text":"KubeObjectStore < Node , NodeApi > \u21b3 NodesStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#accessors","text":"contextItems masterNodes query selectedItems workerNodes","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#constructor","text":"\u2022 new NodesStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#api","text":"\u2022 Readonly api : NodeApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Node ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , NodeStatus , NodeSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#items","text":"\u2022 items : IObservableArray < Node >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#masternodes","text":"\u2022 get masterNodes (): Node []","title":"masterNodes"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#workernodes","text":"\u2022 get workerNodes (): Node []","title":"workerNodes"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#iterator","text":"\u25b8 [iterator] (): Generator < Node , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#create","text":"\u25b8 create ( params , data? ): Promise < Node >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Node >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Node []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Node []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Node","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Node []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Node","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Node","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getitems","text":"\u25b8 getItems (): Node []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#getwarningscount","text":"\u25b8 getWarningsCount (): number","title":"getWarningsCount"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#load","text":"\u25b8 load ( params ): Promise < Node >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Node []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Node >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Node >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Node []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Node []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Node >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Node []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Node []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#update","text":"\u25b8 update ( item , data ): Promise < Node >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.NodesStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Node >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/","text":"Class: PersistentVolumesStore # Renderer . K8sApi .PersistentVolumesStore Hierarchy # KubeObjectStore < PersistentVolume , PersistentVolumeApi > \u21b3 PersistentVolumesStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getByStorageClass getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new PersistentVolumesStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api PersistentVolumeApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : PersistentVolumeApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : PersistentVolume ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item PersistentVolume Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , PersistentVolumeStatus , PersistentVolumeSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < PersistentVolume > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < PersistentVolume , void , undefined > Returns # Generator < PersistentVolume , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < PersistentVolume > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PersistentVolume > Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | PersistentVolume > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PersistentVolume > Returns # Promise < null | PersistentVolume > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): PersistentVolume [] Parameters # Name Type items PersistentVolume [] Returns # PersistentVolume [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): PersistentVolume [] Parameters # Name Type namespace string | string [] strict? boolean Returns # PersistentVolume [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | PersistentVolume Parameters # Name Type id string Returns # undefined | PersistentVolume Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): PersistentVolume [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # PersistentVolume [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | PersistentVolume Parameters # Name Type name string namespace? string Returns # undefined | PersistentVolume Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | PersistentVolume Parameters # Name Type path string Returns # undefined | PersistentVolume Inherited from # KubeObjectStore.getByPath getByStorageClass # \u25b8 getByStorageClass ( storageClass ): PersistentVolume [] Parameters # Name Type storageClass StorageClass Returns # PersistentVolume [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): PersistentVolume [] Returns # PersistentVolume [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item PersistentVolume Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? PersistentVolume [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < PersistentVolume > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PersistentVolume []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | PersistentVolume []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < PersistentVolume > Parameters # Name Type resourcePath string Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | PersistentVolume > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | PersistentVolume > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PersistentVolume []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < PersistentVolume []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PersistentVolume [] Parameters # Name Type partialItems PersistentVolume [] \u00abdestructured\u00bb MergeItemsOptions Returns # PersistentVolume [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < PersistentVolume > Parameters # Name Type item PersistentVolume patch Patch Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): PersistentVolume [] Parameters # Name Type items PersistentVolume [] Returns # PersistentVolume [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | PersistentVolume []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | PersistentVolume []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item PersistentVolume Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item PersistentVolume request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items PersistentVolume [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item PersistentVolume Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # PersistentVolume [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item PersistentVolume Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? PersistentVolume [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item PersistentVolume Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < PersistentVolume > Parameters # Name Type item PersistentVolume data PartialObjectDeep < PersistentVolume > Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < PersistentVolume > Parameters # Name Type item PersistentVolume request () => Promise < PersistentVolume > Returns # Promise < PersistentVolume > Inherited from # KubeObjectStore.updateItem","title":"Class: PersistentVolumesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#class-persistentvolumesstore","text":"Renderer . K8sApi .PersistentVolumesStore","title":"Class: PersistentVolumesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#hierarchy","text":"KubeObjectStore < PersistentVolume , PersistentVolumeApi > \u21b3 PersistentVolumesStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getByStorageClass getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#constructor","text":"\u2022 new PersistentVolumesStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#api","text":"\u2022 Readonly api : PersistentVolumeApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : PersistentVolume ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , PersistentVolumeStatus , PersistentVolumeSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#items","text":"\u2022 items : IObservableArray < PersistentVolume >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#iterator","text":"\u25b8 [iterator] (): Generator < PersistentVolume , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#create","text":"\u25b8 create ( params , data? ): Promise < PersistentVolume >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | PersistentVolume >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): PersistentVolume []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): PersistentVolume []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbyid","text":"\u25b8 getById ( id ): undefined | PersistentVolume","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): PersistentVolume []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | PersistentVolume","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | PersistentVolume","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getbystorageclass","text":"\u25b8 getByStorageClass ( storageClass ): PersistentVolume []","title":"getByStorageClass"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#getitems","text":"\u25b8 getItems (): PersistentVolume []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#load","text":"\u25b8 load ( params ): Promise < PersistentVolume >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PersistentVolume []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < PersistentVolume >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | PersistentVolume >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PersistentVolume []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PersistentVolume []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < PersistentVolume >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): PersistentVolume []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | PersistentVolume []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#update","text":"\u25b8 update ( item , data ): Promise < PersistentVolume >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < PersistentVolume >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/","text":"Class: PodDisruptionBudgetsStore # Renderer . K8sApi .PodDisruptionBudgetsStore Hierarchy # KubeObjectStore < PodDisruptionBudget , PodDisruptionBudgetApi > \u21b3 PodDisruptionBudgetsStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new PodDisruptionBudgetsStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api PodDisruptionBudgetApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : PodDisruptionBudgetApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : PodDisruptionBudget ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item PodDisruptionBudget Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , V1Beta1PodDisruptionBudgetStatus | V1PodDisruptionBudgetStatus , PodDisruptionBudgetSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < PodDisruptionBudget > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < PodDisruptionBudget , void , undefined > Returns # Generator < PodDisruptionBudget , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < PodDisruptionBudget > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PodDisruptionBudget > Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | PodDisruptionBudget > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PodDisruptionBudget > Returns # Promise < null | PodDisruptionBudget > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): PodDisruptionBudget [] Parameters # Name Type items PodDisruptionBudget [] Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): PodDisruptionBudget [] Parameters # Name Type namespace string | string [] strict? boolean Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | PodDisruptionBudget Parameters # Name Type id string Returns # undefined | PodDisruptionBudget Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): PodDisruptionBudget [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | PodDisruptionBudget Parameters # Name Type name string namespace? string Returns # undefined | PodDisruptionBudget Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | PodDisruptionBudget Parameters # Name Type path string Returns # undefined | PodDisruptionBudget Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): PodDisruptionBudget [] Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item PodDisruptionBudget Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? PodDisruptionBudget [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < PodDisruptionBudget > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PodDisruptionBudget []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | PodDisruptionBudget []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < PodDisruptionBudget > Parameters # Name Type resourcePath string Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | PodDisruptionBudget > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | PodDisruptionBudget > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PodDisruptionBudget []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < PodDisruptionBudget []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PodDisruptionBudget [] Parameters # Name Type partialItems PodDisruptionBudget [] \u00abdestructured\u00bb MergeItemsOptions Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < PodDisruptionBudget > Parameters # Name Type item PodDisruptionBudget patch Patch Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): PodDisruptionBudget [] Parameters # Name Type items PodDisruptionBudget [] Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | PodDisruptionBudget []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | PodDisruptionBudget []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item PodDisruptionBudget Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item PodDisruptionBudget request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items PodDisruptionBudget [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item PodDisruptionBudget Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # PodDisruptionBudget [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item PodDisruptionBudget Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? PodDisruptionBudget [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item PodDisruptionBudget Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < PodDisruptionBudget > Parameters # Name Type item PodDisruptionBudget data PartialObjectDeep < PodDisruptionBudget > Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < PodDisruptionBudget > Parameters # Name Type item PodDisruptionBudget request () => Promise < PodDisruptionBudget > Returns # Promise < PodDisruptionBudget > Inherited from # KubeObjectStore.updateItem","title":"Class: PodDisruptionBudgetsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#class-poddisruptionbudgetsstore","text":"Renderer . K8sApi .PodDisruptionBudgetsStore","title":"Class: PodDisruptionBudgetsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#hierarchy","text":"KubeObjectStore < PodDisruptionBudget , PodDisruptionBudgetApi > \u21b3 PodDisruptionBudgetsStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#constructor","text":"\u2022 new PodDisruptionBudgetsStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#api","text":"\u2022 Readonly api : PodDisruptionBudgetApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : PodDisruptionBudget ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , V1Beta1PodDisruptionBudgetStatus | V1PodDisruptionBudgetStatus , PodDisruptionBudgetSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#items","text":"\u2022 items : IObservableArray < PodDisruptionBudget >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#iterator","text":"\u25b8 [iterator] (): Generator < PodDisruptionBudget , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#create","text":"\u25b8 create ( params , data? ): Promise < PodDisruptionBudget >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | PodDisruptionBudget >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): PodDisruptionBudget []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): PodDisruptionBudget []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbyid","text":"\u25b8 getById ( id ): undefined | PodDisruptionBudget","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): PodDisruptionBudget []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | PodDisruptionBudget","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | PodDisruptionBudget","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#getitems","text":"\u25b8 getItems (): PodDisruptionBudget []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#load","text":"\u25b8 load ( params ): Promise < PodDisruptionBudget >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PodDisruptionBudget []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < PodDisruptionBudget >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | PodDisruptionBudget >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PodDisruptionBudget []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PodDisruptionBudget []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < PodDisruptionBudget >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): PodDisruptionBudget []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | PodDisruptionBudget []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#update","text":"\u25b8 update ( item , data ): Promise < PodDisruptionBudget >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < PodDisruptionBudget >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/","text":"Class: PodsStore # Renderer . K8sApi .PodsStore Hierarchy # KubeObjectStore < Pod , PodApi > \u21b3 PodsStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items kubeMetrics limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getPodKubeMetrics getPodsByNode getPodsByOwner getPodsByOwnerId getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems loadKubeMetrics mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new PodsStore ( dependencies , api , opts? ) Parameters # Name Type dependencies PodStoreDependencies api PodApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : PodApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Pod ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Pod Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : PodStoreDependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , PodStatus , PodSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Pod > Inherited from # KubeObjectStore.items kubeMetrics # \u2022 Readonly kubeMetrics : IObservableArray < PodMetrics > limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Pod , void , undefined > Returns # Generator < Pod , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Pod > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Pod > Returns # Promise < Pod > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Pod > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Pod > Returns # Promise < null | Pod > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Pod [] Parameters # Name Type items Pod [] Returns # Pod [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Pod [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Pod [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Pod Parameters # Name Type id string Returns # undefined | Pod Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Pod [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Pod [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Pod Parameters # Name Type name string namespace? string Returns # undefined | Pod Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Pod Parameters # Name Type path string Returns # undefined | Pod Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Pod [] Returns # Pod [] Inherited from # KubeObjectStore.getItems getPodKubeMetrics # \u25b8 getPodKubeMetrics ( pod ): Object Parameters # Name Type pod Pod Returns # Object Name Type cpu number memory number getPodsByNode # \u25b8 getPodsByNode ( node ): Pod [] Parameters # Name Type node string Returns # Pod [] getPodsByOwner # \u25b8 getPodsByOwner ( workload ): Pod [] Parameters # Name Type workload KubeObject < NamespaceScopedMetadata , unknown , unknown > Returns # Pod [] getPodsByOwnerId # \u25b8 getPodsByOwnerId ( workloadId ): Pod [] Parameters # Name Type workloadId string Returns # Pod [] getStatuses # \u25b8 getStatuses ( pods ): Dictionary < number > Parameters # Name Type pods Pod [] Returns # Dictionary < number > getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Pod Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Pod [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Pod > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Pod > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Pod []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Pod []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Pod > Parameters # Name Type resourcePath string Returns # Promise < Pod > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Pod > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Pod > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Pod []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Pod []> Inherited from # KubeObjectStore.loadItems loadKubeMetrics # \u25b8 loadKubeMetrics ( namespace? ): Promise < void > Parameters # Name Type namespace? string Returns # Promise < void > mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Pod [] Parameters # Name Type partialItems Pod [] \u00abdestructured\u00bb MergeItemsOptions Returns # Pod [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Pod > Parameters # Name Type item Pod patch Patch Returns # Promise < Pod > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Pod [] Parameters # Name Type items Pod [] Returns # Pod [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Pod []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Pod []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Pod Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Pod request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Pod [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Pod Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Pod [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Pod Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Pod [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Pod Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Pod > Parameters # Name Type item Pod data PartialObjectDeep < Pod > Returns # Promise < Pod > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Pod > Parameters # Name Type item Pod request () => Promise < Pod > Returns # Promise < Pod > Inherited from # KubeObjectStore.updateItem","title":"Class: PodsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#class-podsstore","text":"Renderer . K8sApi .PodsStore","title":"Class: PodsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#hierarchy","text":"KubeObjectStore < Pod , PodApi > \u21b3 PodsStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items kubeMetrics limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getPodKubeMetrics getPodsByNode getPodsByOwner getPodsByOwnerId getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems loadKubeMetrics mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#constructor","text":"\u2022 new PodsStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#api","text":"\u2022 Readonly api : PodApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Pod ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#dependencies","text":"\u2022 Protected Readonly dependencies : PodStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , PodStatus , PodSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#items","text":"\u2022 items : IObservableArray < Pod >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#kubemetrics","text":"\u2022 Readonly kubeMetrics : IObservableArray < PodMetrics >","title":"kubeMetrics"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#iterator","text":"\u25b8 [iterator] (): Generator < Pod , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#create","text":"\u25b8 create ( params , data? ): Promise < Pod >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Pod >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Pod []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Pod []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Pod","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Pod []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Pod","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Pod","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getitems","text":"\u25b8 getItems (): Pod []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodkubemetrics","text":"\u25b8 getPodKubeMetrics ( pod ): Object","title":"getPodKubeMetrics"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodsbynode","text":"\u25b8 getPodsByNode ( node ): Pod []","title":"getPodsByNode"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodsbyowner","text":"\u25b8 getPodsByOwner ( workload ): Pod []","title":"getPodsByOwner"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getpodsbyownerid","text":"\u25b8 getPodsByOwnerId ( workloadId ): Pod []","title":"getPodsByOwnerId"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#getstatuses","text":"\u25b8 getStatuses ( pods ): Dictionary < number >","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#load","text":"\u25b8 load ( params ): Promise < Pod >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Pod []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Pod >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Pod >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Pod []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#loadkubemetrics","text":"\u25b8 loadKubeMetrics ( namespace? ): Promise < void >","title":"loadKubeMetrics"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Pod []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Pod >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Pod []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Pod []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#update","text":"\u25b8 update ( item , data ): Promise < Pod >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PodsStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Pod >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/","text":"Class: PriorityClassStoreStore # Renderer . K8sApi .PriorityClassStoreStore Hierarchy # KubeObjectStore < PriorityClass , PriorityClassApi > \u21b3 PriorityClassStoreStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new PriorityClassStoreStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api PriorityClassApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : PriorityClassApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : PriorityClass ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item PriorityClass Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < PriorityClassData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < PriorityClass > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < PriorityClass , void , undefined > Returns # Generator < PriorityClass , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < PriorityClass > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PriorityClass > Returns # Promise < PriorityClass > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | PriorityClass > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PriorityClass > Returns # Promise < null | PriorityClass > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): PriorityClass [] Parameters # Name Type items PriorityClass [] Returns # PriorityClass [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): PriorityClass [] Parameters # Name Type namespace string | string [] strict? boolean Returns # PriorityClass [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | PriorityClass Parameters # Name Type id string Returns # undefined | PriorityClass Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): PriorityClass [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # PriorityClass [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | PriorityClass Parameters # Name Type name string namespace? string Returns # undefined | PriorityClass Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | PriorityClass Parameters # Name Type path string Returns # undefined | PriorityClass Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): PriorityClass [] Returns # PriorityClass [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item PriorityClass Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? PriorityClass [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < PriorityClass > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < PriorityClass > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PriorityClass []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | PriorityClass []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < PriorityClass > Parameters # Name Type resourcePath string Returns # Promise < PriorityClass > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | PriorityClass > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | PriorityClass > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PriorityClass []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < PriorityClass []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PriorityClass [] Parameters # Name Type partialItems PriorityClass [] \u00abdestructured\u00bb MergeItemsOptions Returns # PriorityClass [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < PriorityClass > Parameters # Name Type item PriorityClass patch Patch Returns # Promise < PriorityClass > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): PriorityClass [] Parameters # Name Type items PriorityClass [] Returns # PriorityClass [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | PriorityClass []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | PriorityClass []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item PriorityClass Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item PriorityClass request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items PriorityClass [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item PriorityClass Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # PriorityClass [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item PriorityClass Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? PriorityClass [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item PriorityClass Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < PriorityClass > Parameters # Name Type item PriorityClass data PartialObjectDeep < PriorityClass > Returns # Promise < PriorityClass > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < PriorityClass > Parameters # Name Type item PriorityClass request () => Promise < PriorityClass > Returns # Promise < PriorityClass > Inherited from # KubeObjectStore.updateItem","title":"Class: PriorityClassStoreStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#class-priorityclassstorestore","text":"Renderer . K8sApi .PriorityClassStoreStore","title":"Class: PriorityClassStoreStore"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#hierarchy","text":"KubeObjectStore < PriorityClass , PriorityClassApi > \u21b3 PriorityClassStoreStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#constructor","text":"\u2022 new PriorityClassStoreStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#api","text":"\u2022 Readonly api : PriorityClassApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : PriorityClass ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < PriorityClassData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#items","text":"\u2022 items : IObservableArray < PriorityClass >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#iterator","text":"\u25b8 [iterator] (): Generator < PriorityClass , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#create","text":"\u25b8 create ( params , data? ): Promise < PriorityClass >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | PriorityClass >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): PriorityClass []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): PriorityClass []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbyid","text":"\u25b8 getById ( id ): undefined | PriorityClass","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): PriorityClass []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | PriorityClass","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | PriorityClass","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#getitems","text":"\u25b8 getItems (): PriorityClass []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#load","text":"\u25b8 load ( params ): Promise < PriorityClass >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PriorityClass []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < PriorityClass >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | PriorityClass >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PriorityClass []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PriorityClass []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < PriorityClass >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): PriorityClass []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | PriorityClass []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#update","text":"\u25b8 update ( item , data ): Promise < PriorityClass >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < PriorityClass >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/","text":"Class: ReplicaSetStore # Renderer . K8sApi .ReplicaSetStore Hierarchy # KubeObjectStore < ReplicaSet , ReplicaSetApi > \u21b3 ReplicaSetStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getReplicaSetsByOwner getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ReplicaSetStore ( dependencies , api , opts? ) Parameters # Name Type dependencies ReplicaSetStoreDependencies api ReplicaSetApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : ReplicaSetApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : ReplicaSet ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item ReplicaSet Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : ReplicaSetStoreDependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , ReplicaSetStatus , ReplicaSetSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < ReplicaSet > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < ReplicaSet , void , undefined > Returns # Generator < ReplicaSet , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < ReplicaSet > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < ReplicaSet > Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | ReplicaSet > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < ReplicaSet > Returns # Promise < null | ReplicaSet > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): ReplicaSet [] Parameters # Name Type items ReplicaSet [] Returns # ReplicaSet [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): ReplicaSet [] Parameters # Name Type namespace string | string [] strict? boolean Returns # ReplicaSet [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | ReplicaSet Parameters # Name Type id string Returns # undefined | ReplicaSet Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): ReplicaSet [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # ReplicaSet [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | ReplicaSet Parameters # Name Type name string namespace? string Returns # undefined | ReplicaSet Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | ReplicaSet Parameters # Name Type path string Returns # undefined | ReplicaSet Inherited from # KubeObjectStore.getByPath getChildPods # \u25b8 getChildPods ( replicaSet ): Pod [] Parameters # Name Type replicaSet ReplicaSet Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): ReplicaSet [] Returns # ReplicaSet [] Inherited from # KubeObjectStore.getItems getReplicaSetsByOwner # \u25b8 getReplicaSetsByOwner ( deployment ): ReplicaSet [] Parameters # Name Type deployment Deployment Returns # ReplicaSet [] getStatuses # \u25b8 getStatuses ( replicaSets ): Object Parameters # Name Type replicaSets ReplicaSet [] Returns # Object Name Type failed number pending number running number getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item ReplicaSet Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? ReplicaSet [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < ReplicaSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ReplicaSet []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | ReplicaSet []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < ReplicaSet > Parameters # Name Type resourcePath string Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | ReplicaSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | ReplicaSet > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ReplicaSet []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < ReplicaSet []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ReplicaSet [] Parameters # Name Type partialItems ReplicaSet [] \u00abdestructured\u00bb MergeItemsOptions Returns # ReplicaSet [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < ReplicaSet > Parameters # Name Type item ReplicaSet patch Patch Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): ReplicaSet [] Parameters # Name Type items ReplicaSet [] Returns # ReplicaSet [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | ReplicaSet []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | ReplicaSet []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item ReplicaSet Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item ReplicaSet request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items ReplicaSet [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item ReplicaSet Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # ReplicaSet [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item ReplicaSet Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? ReplicaSet [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item ReplicaSet Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < ReplicaSet > Parameters # Name Type item ReplicaSet data PartialObjectDeep < ReplicaSet > Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < ReplicaSet > Parameters # Name Type item ReplicaSet request () => Promise < ReplicaSet > Returns # Promise < ReplicaSet > Inherited from # KubeObjectStore.updateItem","title":"Class: ReplicaSetStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#class-replicasetstore","text":"Renderer . K8sApi .ReplicaSetStore","title":"Class: ReplicaSetStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#hierarchy","text":"KubeObjectStore < ReplicaSet , ReplicaSetApi > \u21b3 ReplicaSetStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getReplicaSetsByOwner getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#constructor","text":"\u2022 new ReplicaSetStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#api","text":"\u2022 Readonly api : ReplicaSetApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : ReplicaSet ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#dependencies","text":"\u2022 Protected Readonly dependencies : ReplicaSetStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , ReplicaSetStatus , ReplicaSetSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#items","text":"\u2022 items : IObservableArray < ReplicaSet >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#iterator","text":"\u25b8 [iterator] (): Generator < ReplicaSet , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#create","text":"\u25b8 create ( params , data? ): Promise < ReplicaSet >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | ReplicaSet >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): ReplicaSet []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): ReplicaSet []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbyid","text":"\u25b8 getById ( id ): undefined | ReplicaSet","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): ReplicaSet []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | ReplicaSet","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | ReplicaSet","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getchildpods","text":"\u25b8 getChildPods ( replicaSet ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getitems","text":"\u25b8 getItems (): ReplicaSet []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getreplicasetsbyowner","text":"\u25b8 getReplicaSetsByOwner ( deployment ): ReplicaSet []","title":"getReplicaSetsByOwner"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#getstatuses","text":"\u25b8 getStatuses ( replicaSets ): Object","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#load","text":"\u25b8 load ( params ): Promise < ReplicaSet >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ReplicaSet []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < ReplicaSet >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | ReplicaSet >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ReplicaSet []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ReplicaSet []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < ReplicaSet >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): ReplicaSet []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | ReplicaSet []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#update","text":"\u25b8 update ( item , data ): Promise < ReplicaSet >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < ReplicaSet >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/","text":"Class: ResourceQuotasStore # Renderer . K8sApi .ResourceQuotasStore Hierarchy # KubeObjectStore < ResourceQuota , ResourceQuotaApi > \u21b3 ResourceQuotasStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ResourceQuotasStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api ResourceQuotaApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : ResourceQuotaApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : ResourceQuota ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item ResourceQuota Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , ResourceQuotaStatus , ResourceQuotaSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < ResourceQuota > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < ResourceQuota , void , undefined > Returns # Generator < ResourceQuota , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < ResourceQuota > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < ResourceQuota > Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | ResourceQuota > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < ResourceQuota > Returns # Promise < null | ResourceQuota > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): ResourceQuota [] Parameters # Name Type items ResourceQuota [] Returns # ResourceQuota [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): ResourceQuota [] Parameters # Name Type namespace string | string [] strict? boolean Returns # ResourceQuota [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | ResourceQuota Parameters # Name Type id string Returns # undefined | ResourceQuota Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): ResourceQuota [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # ResourceQuota [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | ResourceQuota Parameters # Name Type name string namespace? string Returns # undefined | ResourceQuota Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | ResourceQuota Parameters # Name Type path string Returns # undefined | ResourceQuota Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): ResourceQuota [] Returns # ResourceQuota [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item ResourceQuota Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? ResourceQuota [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < ResourceQuota > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ResourceQuota []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | ResourceQuota []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < ResourceQuota > Parameters # Name Type resourcePath string Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | ResourceQuota > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | ResourceQuota > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ResourceQuota []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < ResourceQuota []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ResourceQuota [] Parameters # Name Type partialItems ResourceQuota [] \u00abdestructured\u00bb MergeItemsOptions Returns # ResourceQuota [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < ResourceQuota > Parameters # Name Type item ResourceQuota patch Patch Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): ResourceQuota [] Parameters # Name Type items ResourceQuota [] Returns # ResourceQuota [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | ResourceQuota []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | ResourceQuota []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item ResourceQuota Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item ResourceQuota request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items ResourceQuota [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item ResourceQuota Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # ResourceQuota [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item ResourceQuota Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? ResourceQuota [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item ResourceQuota Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < ResourceQuota > Parameters # Name Type item ResourceQuota data PartialObjectDeep < ResourceQuota > Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < ResourceQuota > Parameters # Name Type item ResourceQuota request () => Promise < ResourceQuota > Returns # Promise < ResourceQuota > Inherited from # KubeObjectStore.updateItem","title":"Class: ResourceQuotasStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#class-resourcequotasstore","text":"Renderer . K8sApi .ResourceQuotasStore","title":"Class: ResourceQuotasStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#hierarchy","text":"KubeObjectStore < ResourceQuota , ResourceQuotaApi > \u21b3 ResourceQuotasStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#constructor","text":"\u2022 new ResourceQuotasStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#api","text":"\u2022 Readonly api : ResourceQuotaApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : ResourceQuota ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , ResourceQuotaStatus , ResourceQuotaSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#items","text":"\u2022 items : IObservableArray < ResourceQuota >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#iterator","text":"\u25b8 [iterator] (): Generator < ResourceQuota , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#create","text":"\u25b8 create ( params , data? ): Promise < ResourceQuota >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | ResourceQuota >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): ResourceQuota []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): ResourceQuota []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbyid","text":"\u25b8 getById ( id ): undefined | ResourceQuota","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): ResourceQuota []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | ResourceQuota","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | ResourceQuota","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#getitems","text":"\u25b8 getItems (): ResourceQuota []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#load","text":"\u25b8 load ( params ): Promise < ResourceQuota >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ResourceQuota []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < ResourceQuota >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | ResourceQuota >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ResourceQuota []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ResourceQuota []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < ResourceQuota >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): ResourceQuota []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | ResourceQuota []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#update","text":"\u25b8 update ( item , data ): Promise < ResourceQuota >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < ResourceQuota >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/","text":"Class: ResourceStack # Renderer . K8sApi .ResourceStack Deprecated Switch to using Common.createResourceStack instead Implements # ResourceApplyingStack Table of contents # Constructors # constructor Methods # kubectlApplyFolder kubectlDeleteFolder Constructors # constructor # \u2022 new ResourceStack ( cluster , name ) Parameters # Name Type cluster KubernetesCluster < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > name string Methods # kubectlApplyFolder # \u25b8 kubectlApplyFolder ( folderPath , templateContext? , extraArgs? ): Promise < string > Parameters # Name Type folderPath string templateContext? any extraArgs? string [] Returns # Promise < string > Implementation of # ResourceApplyingStack.kubectlApplyFolder kubectlDeleteFolder # \u25b8 kubectlDeleteFolder ( folderPath , templateContext? , extraArgs? ): Promise < string > Parameters # Name Type folderPath string templateContext? any extraArgs? string [] Returns # Promise < string > Implementation of # ResourceApplyingStack.kubectlDeleteFolder","title":"Class: ResourceStack"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#class-resourcestack","text":"Renderer . K8sApi .ResourceStack Deprecated Switch to using Common.createResourceStack instead","title":"Class: ResourceStack"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#implements","text":"ResourceApplyingStack","title":"Implements"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#methods","text":"kubectlApplyFolder kubectlDeleteFolder","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#constructor","text":"\u2022 new ResourceStack ( cluster , name )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#kubectlapplyfolder","text":"\u25b8 kubectlApplyFolder ( folderPath , templateContext? , extraArgs? ): Promise < string >","title":"kubectlApplyFolder"},{"location":"extensions/api/classes/Renderer.K8sApi.ResourceStack/#kubectldeletefolder","text":"\u25b8 kubectlDeleteFolder ( folderPath , templateContext? , extraArgs? ): Promise < string >","title":"kubectlDeleteFolder"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/","text":"Class: RoleBindingsStore # Renderer . K8sApi .RoleBindingsStore Hierarchy # KubeObjectStore < RoleBinding , RoleBindingApi , RoleBindingData > \u21b3 RoleBindingsStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems removeSubjects reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem updateSubjects Constructors # constructor # \u2022 new RoleBindingsStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api RoleBindingApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : RoleBindingApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : RoleBinding ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item RoleBinding Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < RoleBindingData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < RoleBinding > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < RoleBinding , void , undefined > Returns # Generator < RoleBinding , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < RoleBinding > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < RoleBinding > Returns # Promise < RoleBinding > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | RoleBinding > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < RoleBinding > Returns # Promise < null | RoleBinding > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): RoleBinding [] Parameters # Name Type items RoleBinding [] Returns # RoleBinding [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): RoleBinding [] Parameters # Name Type namespace string | string [] strict? boolean Returns # RoleBinding [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | RoleBinding Parameters # Name Type id string Returns # undefined | RoleBinding Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): RoleBinding [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # RoleBinding [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | RoleBinding Parameters # Name Type name string namespace? string Returns # undefined | RoleBinding Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | RoleBinding Parameters # Name Type path string Returns # undefined | RoleBinding Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): RoleBinding [] Returns # RoleBinding [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item RoleBinding Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? RoleBinding [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < RoleBinding > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < RoleBinding > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | RoleBinding []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | RoleBinding []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < RoleBinding > Parameters # Name Type resourcePath string Returns # Promise < RoleBinding > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | RoleBinding > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | RoleBinding > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < RoleBinding []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < RoleBinding []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): RoleBinding [] Parameters # Name Type partialItems RoleBinding [] \u00abdestructured\u00bb MergeItemsOptions Returns # RoleBinding [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < RoleBinding > Parameters # Name Type item RoleBinding patch Patch Returns # Promise < RoleBinding > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): RoleBinding [] Parameters # Name Type items RoleBinding [] Returns # RoleBinding [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | RoleBinding []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | RoleBinding []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item RoleBinding Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item RoleBinding request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items RoleBinding [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems removeSubjects # \u25b8 removeSubjects ( roleBinding , subjectsToRemove ): Promise < RoleBinding > Parameters # Name Type roleBinding RoleBinding subjectsToRemove Iterable < Subject > Returns # Promise < RoleBinding > reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item RoleBinding Returns # void Inherited from # KubeObjectStore.select sortItems # \u25b8 Protected sortItems ( items ): RoleBinding [] Parameters # Name Type items RoleBinding [] Returns # RoleBinding [] Overrides # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item RoleBinding Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? RoleBinding [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item RoleBinding Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < RoleBinding > Parameters # Name Type item RoleBinding data PartialObjectDeep < RoleBinding > Returns # Promise < RoleBinding > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < RoleBinding > Parameters # Name Type item RoleBinding request () => Promise < RoleBinding > Returns # Promise < RoleBinding > Inherited from # KubeObjectStore.updateItem updateSubjects # \u25b8 updateSubjects ( roleBinding , subjects ): Promise < RoleBinding > Parameters # Name Type roleBinding RoleBinding subjects Subject [] Returns # Promise < RoleBinding >","title":"Class: RoleBindingsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#class-rolebindingsstore","text":"Renderer . K8sApi .RoleBindingsStore","title":"Class: RoleBindingsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#hierarchy","text":"KubeObjectStore < RoleBinding , RoleBindingApi , RoleBindingData > \u21b3 RoleBindingsStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems removeSubjects reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem updateSubjects","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#constructor","text":"\u2022 new RoleBindingsStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#api","text":"\u2022 Readonly api : RoleBindingApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : RoleBinding ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < RoleBindingData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#items","text":"\u2022 items : IObservableArray < RoleBinding >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#iterator","text":"\u25b8 [iterator] (): Generator < RoleBinding , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#create","text":"\u25b8 create ( params , data? ): Promise < RoleBinding >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | RoleBinding >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): RoleBinding []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): RoleBinding []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbyid","text":"\u25b8 getById ( id ): undefined | RoleBinding","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): RoleBinding []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | RoleBinding","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | RoleBinding","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#getitems","text":"\u25b8 getItems (): RoleBinding []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#load","text":"\u25b8 load ( params ): Promise < RoleBinding >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | RoleBinding []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < RoleBinding >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | RoleBinding >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < RoleBinding []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): RoleBinding []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < RoleBinding >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): RoleBinding []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | RoleBinding []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#removesubjects","text":"\u25b8 removeSubjects ( roleBinding , subjectsToRemove ): Promise < RoleBinding >","title":"removeSubjects"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#sortitems","text":"\u25b8 Protected sortItems ( items ): RoleBinding []","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#update","text":"\u25b8 update ( item , data ): Promise < RoleBinding >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < RoleBinding >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/#updatesubjects","text":"\u25b8 updateSubjects ( roleBinding , subjects ): Promise < RoleBinding >","title":"updateSubjects"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/","text":"Class: RolesStore # Renderer . K8sApi .RolesStore Hierarchy # KubeObjectStore < Role , RoleApi , RoleData > \u21b3 RolesStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new RolesStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api RoleApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : RoleApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Role ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Role Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < RoleData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Role > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Role , void , undefined > Returns # Generator < Role , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Role > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Role > Returns # Promise < Role > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Role > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Role > Returns # Promise < null | Role > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Role [] Parameters # Name Type items Role [] Returns # Role [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Role [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Role [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Role Parameters # Name Type id string Returns # undefined | Role Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Role [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Role [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Role Parameters # Name Type name string namespace? string Returns # undefined | Role Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Role Parameters # Name Type path string Returns # undefined | Role Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Role [] Returns # Role [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Role Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Role [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Role > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Role > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Role []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Role []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Role > Parameters # Name Type resourcePath string Returns # Promise < Role > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Role > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Role > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Role []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Role []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Role [] Parameters # Name Type partialItems Role [] \u00abdestructured\u00bb MergeItemsOptions Returns # Role [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Role > Parameters # Name Type item Role patch Patch Returns # Promise < Role > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Role [] Parameters # Name Type items Role [] Returns # Role [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Role []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Role []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Role Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Role request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Role [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Role Returns # void Inherited from # KubeObjectStore.select sortItems # \u25b8 Protected sortItems ( items ): Role [] Parameters # Name Type items Role [] Returns # Role [] Overrides # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Role Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Role [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Role Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Role > Parameters # Name Type item Role data PartialObjectDeep < Role > Returns # Promise < Role > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Role > Parameters # Name Type item Role request () => Promise < Role > Returns # Promise < Role > Inherited from # KubeObjectStore.updateItem","title":"Class: RolesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#class-rolesstore","text":"Renderer . K8sApi .RolesStore","title":"Class: RolesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#hierarchy","text":"KubeObjectStore < Role , RoleApi , RoleData > \u21b3 RolesStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#constructor","text":"\u2022 new RolesStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#api","text":"\u2022 Readonly api : RoleApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Role ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < RoleData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#items","text":"\u2022 items : IObservableArray < Role >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#iterator","text":"\u25b8 [iterator] (): Generator < Role , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#create","text":"\u25b8 create ( params , data? ): Promise < Role >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Role >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Role []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Role []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Role","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Role []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Role","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Role","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#getitems","text":"\u25b8 getItems (): Role []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#load","text":"\u25b8 load ( params ): Promise < Role >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Role []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Role >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Role >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Role []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Role []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Role >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Role []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Role []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#sortitems","text":"\u25b8 Protected sortItems ( items ): Role []","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#update","text":"\u25b8 update ( item , data ): Promise < Role >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.RolesStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Role >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/","text":"Class: SecretsStore # Renderer . K8sApi .SecretsStore Hierarchy # KubeObjectStore < Secret , SecretApi , SecretData > \u21b3 SecretsStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new SecretsStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api SecretApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : SecretApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Secret ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Secret Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < SecretData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Secret > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Secret , void , undefined > Returns # Generator < Secret , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Secret > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Secret > Returns # Promise < Secret > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Secret > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Secret > Returns # Promise < null | Secret > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Secret [] Parameters # Name Type items Secret [] Returns # Secret [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Secret [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Secret [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Secret Parameters # Name Type id string Returns # undefined | Secret Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Secret [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Secret [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Secret Parameters # Name Type name string namespace? string Returns # undefined | Secret Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Secret Parameters # Name Type path string Returns # undefined | Secret Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Secret [] Returns # Secret [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Secret Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Secret [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Secret > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Secret > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Secret []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Secret []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Secret > Parameters # Name Type resourcePath string Returns # Promise < Secret > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Secret > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Secret > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Secret []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Secret []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Secret [] Parameters # Name Type partialItems Secret [] \u00abdestructured\u00bb MergeItemsOptions Returns # Secret [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Secret > Parameters # Name Type item Secret patch Patch Returns # Promise < Secret > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Secret [] Parameters # Name Type items Secret [] Returns # Secret [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Secret []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Secret []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Secret Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Secret request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Secret [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Secret Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Secret [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Secret Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Secret [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Secret Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Secret > Parameters # Name Type item Secret data PartialObjectDeep < Secret > Returns # Promise < Secret > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Secret > Parameters # Name Type item Secret request () => Promise < Secret > Returns # Promise < Secret > Inherited from # KubeObjectStore.updateItem","title":"Class: SecretsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#class-secretsstore","text":"Renderer . K8sApi .SecretsStore","title":"Class: SecretsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#hierarchy","text":"KubeObjectStore < Secret , SecretApi , SecretData > \u21b3 SecretsStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#constructor","text":"\u2022 new SecretsStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#api","text":"\u2022 Readonly api : SecretApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Secret ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < SecretData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#items","text":"\u2022 items : IObservableArray < Secret >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#iterator","text":"\u25b8 [iterator] (): Generator < Secret , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#create","text":"\u25b8 create ( params , data? ): Promise < Secret >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Secret >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Secret []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Secret []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Secret","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Secret []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Secret","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Secret","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#getitems","text":"\u25b8 getItems (): Secret []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#load","text":"\u25b8 load ( params ): Promise < Secret >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Secret []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Secret >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Secret >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Secret []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Secret []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Secret >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Secret []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Secret []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#update","text":"\u25b8 update ( item , data ): Promise < Secret >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.SecretsStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Secret >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/","text":"Class: ServiceAccountsStore # Renderer . K8sApi .ServiceAccountsStore Hierarchy # KubeObjectStore < ServiceAccount , ServiceAccountApi , ServiceAccountData > \u21b3 ServiceAccountsStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ServiceAccountsStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api ServiceAccountApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : ServiceAccountApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : ServiceAccount ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item ServiceAccount Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < ServiceAccountData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < ServiceAccount > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < ServiceAccount , void , undefined > Returns # Generator < ServiceAccount , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < ServiceAccount > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < ServiceAccount > Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params ): Promise < null | ServiceAccount > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | ServiceAccount > Overrides # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): ServiceAccount [] Parameters # Name Type items ServiceAccount [] Returns # ServiceAccount [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): ServiceAccount [] Parameters # Name Type namespace string | string [] strict? boolean Returns # ServiceAccount [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | ServiceAccount Parameters # Name Type id string Returns # undefined | ServiceAccount Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): ServiceAccount [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # ServiceAccount [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | ServiceAccount Parameters # Name Type name string namespace? string Returns # undefined | ServiceAccount Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | ServiceAccount Parameters # Name Type path string Returns # undefined | ServiceAccount Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): ServiceAccount [] Returns # ServiceAccount [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item ServiceAccount Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? ServiceAccount [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < ServiceAccount > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ServiceAccount []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | ServiceAccount []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < ServiceAccount > Parameters # Name Type resourcePath string Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | ServiceAccount > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | ServiceAccount > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ServiceAccount []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < ServiceAccount []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ServiceAccount [] Parameters # Name Type partialItems ServiceAccount [] \u00abdestructured\u00bb MergeItemsOptions Returns # ServiceAccount [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < ServiceAccount > Parameters # Name Type item ServiceAccount patch Patch Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): ServiceAccount [] Parameters # Name Type items ServiceAccount [] Returns # ServiceAccount [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | ServiceAccount []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | ServiceAccount []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item ServiceAccount Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item ServiceAccount request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items ServiceAccount [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item ServiceAccount Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # ServiceAccount [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item ServiceAccount Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? ServiceAccount [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item ServiceAccount Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < ServiceAccount > Parameters # Name Type item ServiceAccount data PartialObjectDeep < ServiceAccount > Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < ServiceAccount > Parameters # Name Type item ServiceAccount request () => Promise < ServiceAccount > Returns # Promise < ServiceAccount > Inherited from # KubeObjectStore.updateItem","title":"Class: ServiceAccountsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#class-serviceaccountsstore","text":"Renderer . K8sApi .ServiceAccountsStore","title":"Class: ServiceAccountsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#hierarchy","text":"KubeObjectStore < ServiceAccount , ServiceAccountApi , ServiceAccountData > \u21b3 ServiceAccountsStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#constructor","text":"\u2022 new ServiceAccountsStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#api","text":"\u2022 Readonly api : ServiceAccountApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : ServiceAccount ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < ServiceAccountData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#items","text":"\u2022 items : IObservableArray < ServiceAccount >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#iterator","text":"\u25b8 [iterator] (): Generator < ServiceAccount , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#create","text":"\u25b8 create ( params , data? ): Promise < ServiceAccount >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#createitem","text":"\u25b8 Protected createItem ( params ): Promise < null | ServiceAccount >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): ServiceAccount []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): ServiceAccount []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbyid","text":"\u25b8 getById ( id ): undefined | ServiceAccount","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): ServiceAccount []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | ServiceAccount","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | ServiceAccount","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#getitems","text":"\u25b8 getItems (): ServiceAccount []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#load","text":"\u25b8 load ( params ): Promise < ServiceAccount >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | ServiceAccount []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < ServiceAccount >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | ServiceAccount >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < ServiceAccount []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): ServiceAccount []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < ServiceAccount >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): ServiceAccount []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | ServiceAccount []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#update","text":"\u25b8 update ( item , data ): Promise < ServiceAccount >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < ServiceAccount >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/","text":"Class: ServiceStore # Renderer . K8sApi .ServiceStore Hierarchy # KubeObjectStore < Service , ServiceApi > \u21b3 ServiceStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ServiceStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api ServiceApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : ServiceApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : Service ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item Service Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , ServiceStatus , ServiceSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < Service > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < Service , void , undefined > Returns # Generator < Service , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Service > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Service > Returns # Promise < Service > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Service > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Service > Returns # Promise < null | Service > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Service [] Parameters # Name Type items Service [] Returns # Service [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Service [] Parameters # Name Type namespace string | string [] strict? boolean Returns # Service [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | Service Parameters # Name Type id string Returns # undefined | Service Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): Service [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Service [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Service Parameters # Name Type name string namespace? string Returns # undefined | Service Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | Service Parameters # Name Type path string Returns # undefined | Service Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): Service [] Returns # Service [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Service Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? Service [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < Service > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Service > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Service []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | Service []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Service > Parameters # Name Type resourcePath string Returns # Promise < Service > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | Service > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Service > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Service []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < Service []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Service [] Parameters # Name Type partialItems Service [] \u00abdestructured\u00bb MergeItemsOptions Returns # Service [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < Service > Parameters # Name Type item Service patch Patch Returns # Promise < Service > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): Service [] Parameters # Name Type items Service [] Returns # Service [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Service []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | Service []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Service Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Service request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Service [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Service Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # Service [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Service Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? Service [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Service Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < Service > Parameters # Name Type item Service data PartialObjectDeep < Service > Returns # Promise < Service > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Service > Parameters # Name Type item Service request () => Promise < Service > Returns # Promise < Service > Inherited from # KubeObjectStore.updateItem","title":"Class: ServiceStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#class-servicestore","text":"Renderer . K8sApi .ServiceStore","title":"Class: ServiceStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#hierarchy","text":"KubeObjectStore < Service , ServiceApi > \u21b3 ServiceStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#constructor","text":"\u2022 new ServiceStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#api","text":"\u2022 Readonly api : ServiceApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : Service ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , ServiceStatus , ServiceSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#items","text":"\u2022 items : IObservableArray < Service >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#iterator","text":"\u25b8 [iterator] (): Generator < Service , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#create","text":"\u25b8 create ( params , data? ): Promise < Service >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | Service >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Service []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Service []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbyid","text":"\u25b8 getById ( id ): undefined | Service","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Service []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | Service","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | Service","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#getitems","text":"\u25b8 getItems (): Service []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#load","text":"\u25b8 load ( params ): Promise < Service >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | Service []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Service >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | Service >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < Service []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): Service []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Service >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Service []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | Service []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#update","text":"\u25b8 update ( item , data ): Promise < Service >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ServiceStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Service >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/","text":"Class: StatefulSetStore # Renderer . K8sApi .StatefulSetStore Hierarchy # KubeObjectStore < StatefulSet , StatefulSetApi > \u21b3 StatefulSetStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new StatefulSetStore ( dependencies , api , opts? ) Parameters # Name Type dependencies Dependencies api StatefulSetApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : StatefulSetApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : StatefulSet ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item StatefulSet Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : Dependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , StatefulSetStatus , StatefulSetSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < StatefulSet > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < StatefulSet , void , undefined > Returns # Generator < StatefulSet , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < StatefulSet > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < StatefulSet > Returns # Promise < StatefulSet > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | StatefulSet > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < StatefulSet > Returns # Promise < null | StatefulSet > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): StatefulSet [] Parameters # Name Type items StatefulSet [] Returns # StatefulSet [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): StatefulSet [] Parameters # Name Type namespace string | string [] strict? boolean Returns # StatefulSet [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | StatefulSet Parameters # Name Type id string Returns # undefined | StatefulSet Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): StatefulSet [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # StatefulSet [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | StatefulSet Parameters # Name Type name string namespace? string Returns # undefined | StatefulSet Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | StatefulSet Parameters # Name Type path string Returns # undefined | StatefulSet Inherited from # KubeObjectStore.getByPath getChildPods # \u25b8 getChildPods ( statefulSet ): Pod [] Parameters # Name Type statefulSet StatefulSet Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): StatefulSet [] Returns # StatefulSet [] Inherited from # KubeObjectStore.getItems getStatuses # \u25b8 getStatuses ( statefulSets ): Object Parameters # Name Type statefulSets StatefulSet [] Returns # Object Name Type failed number pending number running number getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item StatefulSet Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? StatefulSet [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < StatefulSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < StatefulSet > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | StatefulSet []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | StatefulSet []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < StatefulSet > Parameters # Name Type resourcePath string Returns # Promise < StatefulSet > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | StatefulSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | StatefulSet > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < StatefulSet []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < StatefulSet []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): StatefulSet [] Parameters # Name Type partialItems StatefulSet [] \u00abdestructured\u00bb MergeItemsOptions Returns # StatefulSet [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < StatefulSet > Parameters # Name Type item StatefulSet patch Patch Returns # Promise < StatefulSet > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): StatefulSet [] Parameters # Name Type items StatefulSet [] Returns # StatefulSet [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | StatefulSet []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | StatefulSet []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item StatefulSet Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item StatefulSet request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items StatefulSet [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item StatefulSet Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # StatefulSet [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item StatefulSet Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? StatefulSet [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item StatefulSet Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < StatefulSet > Parameters # Name Type item StatefulSet data PartialObjectDeep < StatefulSet > Returns # Promise < StatefulSet > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < StatefulSet > Parameters # Name Type item StatefulSet request () => Promise < StatefulSet > Returns # Promise < StatefulSet > Inherited from # KubeObjectStore.updateItem","title":"Class: StatefulSetStore"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#class-statefulsetstore","text":"Renderer . K8sApi .StatefulSetStore","title":"Class: StatefulSetStore"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#hierarchy","text":"KubeObjectStore < StatefulSet , StatefulSetApi > \u21b3 StatefulSetStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#constructor","text":"\u2022 new StatefulSetStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#api","text":"\u2022 Readonly api : StatefulSetApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : StatefulSet ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#dependencies","text":"\u2022 Protected Readonly dependencies : Dependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , StatefulSetStatus , StatefulSetSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#items","text":"\u2022 items : IObservableArray < StatefulSet >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#iterator","text":"\u25b8 [iterator] (): Generator < StatefulSet , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#create","text":"\u25b8 create ( params , data? ): Promise < StatefulSet >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | StatefulSet >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): StatefulSet []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): StatefulSet []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbyid","text":"\u25b8 getById ( id ): undefined | StatefulSet","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): StatefulSet []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | StatefulSet","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | StatefulSet","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getchildpods","text":"\u25b8 getChildPods ( statefulSet ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getitems","text":"\u25b8 getItems (): StatefulSet []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#getstatuses","text":"\u25b8 getStatuses ( statefulSets ): Object","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#load","text":"\u25b8 load ( params ): Promise < StatefulSet >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | StatefulSet []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < StatefulSet >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | StatefulSet >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < StatefulSet []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): StatefulSet []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < StatefulSet >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): StatefulSet []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | StatefulSet []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#update","text":"\u25b8 update ( item , data ): Promise < StatefulSet >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.StatefulSetStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < StatefulSet >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/","text":"Class: StorageClassStore # Renderer . K8sApi .StorageClassStore Hierarchy # KubeObjectStore < StorageClass , StorageClassApi , StorageClassData > \u21b3 StorageClassStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getPersistentVolumes getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new StorageClassStore ( dependencies , api , opts? ) Parameters # Name Type dependencies StorageClassStoreDependencies api StorageClassApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : StorageClassApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : StorageClass ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item StorageClass Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : StorageClassStoreDependencies Overrides # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < StorageClassData >> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < StorageClass > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < StorageClass , void , undefined > Returns # Generator < StorageClass , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < StorageClass > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < StorageClass > Returns # Promise < StorageClass > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | StorageClass > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < StorageClass > Returns # Promise < null | StorageClass > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): StorageClass [] Parameters # Name Type items StorageClass [] Returns # StorageClass [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): StorageClass [] Parameters # Name Type namespace string | string [] strict? boolean Returns # StorageClass [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | StorageClass Parameters # Name Type id string Returns # undefined | StorageClass Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): StorageClass [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # StorageClass [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | StorageClass Parameters # Name Type name string namespace? string Returns # undefined | StorageClass Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | StorageClass Parameters # Name Type path string Returns # undefined | StorageClass Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): StorageClass [] Returns # StorageClass [] Inherited from # KubeObjectStore.getItems getPersistentVolumes # \u25b8 getPersistentVolumes ( storageClass ): PersistentVolume [] Parameters # Name Type storageClass StorageClass Returns # PersistentVolume [] getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item StorageClass Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? StorageClass [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < StorageClass > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < StorageClass > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | StorageClass []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | StorageClass []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < StorageClass > Parameters # Name Type resourcePath string Returns # Promise < StorageClass > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | StorageClass > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | StorageClass > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < StorageClass []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < StorageClass []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): StorageClass [] Parameters # Name Type partialItems StorageClass [] \u00abdestructured\u00bb MergeItemsOptions Returns # StorageClass [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < StorageClass > Parameters # Name Type item StorageClass patch Patch Returns # Promise < StorageClass > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): StorageClass [] Parameters # Name Type items StorageClass [] Returns # StorageClass [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | StorageClass []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | StorageClass []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item StorageClass Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item StorageClass request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items StorageClass [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item StorageClass Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # StorageClass [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item StorageClass Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? StorageClass [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item StorageClass Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < StorageClass > Parameters # Name Type item StorageClass data PartialObjectDeep < StorageClass > Returns # Promise < StorageClass > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < StorageClass > Parameters # Name Type item StorageClass request () => Promise < StorageClass > Returns # Promise < StorageClass > Inherited from # KubeObjectStore.updateItem","title":"Class: StorageClassStore"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#class-storageclassstore","text":"Renderer . K8sApi .StorageClassStore","title":"Class: StorageClassStore"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#hierarchy","text":"KubeObjectStore < StorageClass , StorageClassApi , StorageClassData > \u21b3 StorageClassStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getPersistentVolumes getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#constructor","text":"\u2022 new StorageClassStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#api","text":"\u2022 Readonly api : StorageClassApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : StorageClass ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#dependencies","text":"\u2022 Protected Readonly dependencies : StorageClassStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < StorageClassData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#items","text":"\u2022 items : IObservableArray < StorageClass >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#iterator","text":"\u25b8 [iterator] (): Generator < StorageClass , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#create","text":"\u25b8 create ( params , data? ): Promise < StorageClass >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | StorageClass >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): StorageClass []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): StorageClass []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbyid","text":"\u25b8 getById ( id ): undefined | StorageClass","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): StorageClass []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | StorageClass","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | StorageClass","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getitems","text":"\u25b8 getItems (): StorageClass []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#getpersistentvolumes","text":"\u25b8 getPersistentVolumes ( storageClass ): PersistentVolume []","title":"getPersistentVolumes"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#load","text":"\u25b8 load ( params ): Promise < StorageClass >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | StorageClass []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < StorageClass >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | StorageClass >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < StorageClass []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): StorageClass []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < StorageClass >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): StorageClass []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | StorageClass []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#update","text":"\u25b8 update ( item , data ): Promise < StorageClass >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.StorageClassStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < StorageClass >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/","text":"Class: VerticalPodAutoscalerStore # Renderer . K8sApi .VerticalPodAutoscalerStore Hierarchy # KubeObjectStore < VerticalPodAutoscaler , VerticalPodAutoscalerApi > \u21b3 VerticalPodAutoscalerStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new VerticalPodAutoscalerStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api VerticalPodAutoscalerApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : VerticalPodAutoscalerApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : VerticalPodAutoscaler ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item VerticalPodAutoscaler Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , VerticalPodAutoscalerStatus , VerticalPodAutoscalerSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < VerticalPodAutoscaler > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < VerticalPodAutoscaler , void , undefined > Returns # Generator < VerticalPodAutoscaler , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < VerticalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < VerticalPodAutoscaler > Returns # Promise < VerticalPodAutoscaler > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | VerticalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < VerticalPodAutoscaler > Returns # Promise < null | VerticalPodAutoscaler > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): VerticalPodAutoscaler [] Parameters # Name Type items VerticalPodAutoscaler [] Returns # VerticalPodAutoscaler [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): VerticalPodAutoscaler [] Parameters # Name Type namespace string | string [] strict? boolean Returns # VerticalPodAutoscaler [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | VerticalPodAutoscaler Parameters # Name Type id string Returns # undefined | VerticalPodAutoscaler Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): VerticalPodAutoscaler [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # VerticalPodAutoscaler [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | VerticalPodAutoscaler Parameters # Name Type name string namespace? string Returns # undefined | VerticalPodAutoscaler Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | VerticalPodAutoscaler Parameters # Name Type path string Returns # undefined | VerticalPodAutoscaler Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): VerticalPodAutoscaler [] Returns # VerticalPodAutoscaler [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item VerticalPodAutoscaler Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? VerticalPodAutoscaler [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < VerticalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < VerticalPodAutoscaler > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | VerticalPodAutoscaler []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | VerticalPodAutoscaler []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < VerticalPodAutoscaler > Parameters # Name Type resourcePath string Returns # Promise < VerticalPodAutoscaler > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | VerticalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | VerticalPodAutoscaler > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < VerticalPodAutoscaler []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < VerticalPodAutoscaler []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): VerticalPodAutoscaler [] Parameters # Name Type partialItems VerticalPodAutoscaler [] \u00abdestructured\u00bb MergeItemsOptions Returns # VerticalPodAutoscaler [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < VerticalPodAutoscaler > Parameters # Name Type item VerticalPodAutoscaler patch Patch Returns # Promise < VerticalPodAutoscaler > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): VerticalPodAutoscaler [] Parameters # Name Type items VerticalPodAutoscaler [] Returns # VerticalPodAutoscaler [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | VerticalPodAutoscaler []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | VerticalPodAutoscaler []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item VerticalPodAutoscaler Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item VerticalPodAutoscaler request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items VerticalPodAutoscaler [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item VerticalPodAutoscaler Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # VerticalPodAutoscaler [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item VerticalPodAutoscaler Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? VerticalPodAutoscaler [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item VerticalPodAutoscaler Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < VerticalPodAutoscaler > Parameters # Name Type item VerticalPodAutoscaler data PartialObjectDeep < VerticalPodAutoscaler > Returns # Promise < VerticalPodAutoscaler > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < VerticalPodAutoscaler > Parameters # Name Type item VerticalPodAutoscaler request () => Promise < VerticalPodAutoscaler > Returns # Promise < VerticalPodAutoscaler > Inherited from # KubeObjectStore.updateItem","title":"Class: VerticalPodAutoscalerStore"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#class-verticalpodautoscalerstore","text":"Renderer . K8sApi .VerticalPodAutoscalerStore","title":"Class: VerticalPodAutoscalerStore"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#hierarchy","text":"KubeObjectStore < VerticalPodAutoscaler , VerticalPodAutoscalerApi > \u21b3 VerticalPodAutoscalerStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#constructor","text":"\u2022 new VerticalPodAutoscalerStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#api","text":"\u2022 Readonly api : VerticalPodAutoscalerApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : VerticalPodAutoscaler ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , VerticalPodAutoscalerStatus , VerticalPodAutoscalerSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#items","text":"\u2022 items : IObservableArray < VerticalPodAutoscaler >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#iterator","text":"\u25b8 [iterator] (): Generator < VerticalPodAutoscaler , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#create","text":"\u25b8 create ( params , data? ): Promise < VerticalPodAutoscaler >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | VerticalPodAutoscaler >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): VerticalPodAutoscaler []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): VerticalPodAutoscaler []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbyid","text":"\u25b8 getById ( id ): undefined | VerticalPodAutoscaler","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): VerticalPodAutoscaler []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | VerticalPodAutoscaler","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | VerticalPodAutoscaler","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#getitems","text":"\u25b8 getItems (): VerticalPodAutoscaler []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#load","text":"\u25b8 load ( params ): Promise < VerticalPodAutoscaler >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | VerticalPodAutoscaler []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < VerticalPodAutoscaler >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | VerticalPodAutoscaler >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < VerticalPodAutoscaler []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): VerticalPodAutoscaler []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < VerticalPodAutoscaler >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): VerticalPodAutoscaler []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | VerticalPodAutoscaler []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#update","text":"\u25b8 update ( item , data ): Promise < VerticalPodAutoscaler >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < VerticalPodAutoscaler >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/","text":"Class: VolumeClaimStore # Renderer . K8sApi .VolumeClaimStore Hierarchy # KubeObjectStore < PersistentVolumeClaim , PersistentVolumeClaimApi > \u21b3 VolumeClaimStore Table of contents # Constructors # constructor Properties # api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds Accessors # contextItems query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new VolumeClaimStore ( dependencies , api , opts? ) Parameters # Name Type dependencies KubeObjectStoreDependencies api PersistentVolumeClaimApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore.constructor Properties # api # \u2022 Readonly api : PersistentVolumeClaimApi Inherited from # KubeObjectStore.api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore.bufferSize defaultSorting # \u2022 Protected defaultSorting : ( item : PersistentVolumeClaim ) => string Type declaration # \u25b8 ( item ): string Parameters # Name Type item PersistentVolumeClaim Returns # string Inherited from # KubeObjectStore.defaultSorting dependencies # \u2022 Protected Readonly dependencies : KubeObjectStoreDependencies Inherited from # KubeObjectStore.dependencies eventsBuffer # \u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , PersistentVolumeClaimStatus , PersistentVolumeClaimSpec >>> Inherited from # KubeObjectStore.eventsBuffer failedLoading # \u2022 failedLoading : boolean Inherited from # KubeObjectStore.failedLoading isLoaded # \u2022 isLoaded : boolean Inherited from # KubeObjectStore.isLoaded isLoading # \u2022 isLoading : boolean Inherited from # KubeObjectStore.isLoading items # \u2022 items : IObservableArray < PersistentVolumeClaim > Inherited from # KubeObjectStore.items limit # \u2022 Readonly limit : undefined | number Inherited from # KubeObjectStore.limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore.selectedItemsIds Accessors # contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems Methods # [iterator] # \u25b8 [iterator] (): Generator < PersistentVolumeClaim , void , undefined > Returns # Generator < PersistentVolumeClaim , void , undefined > Inherited from # KubeObjectStore.__@iterator@188 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type delay? number Returns # void Inherited from # KubeObjectStore.bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < PersistentVolumeClaim > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PersistentVolumeClaim > Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore.create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | PersistentVolumeClaim > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < PersistentVolumeClaim > Returns # Promise < null | PersistentVolumeClaim > Inherited from # KubeObjectStore.createItem filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): PersistentVolumeClaim [] Parameters # Name Type items PersistentVolumeClaim [] Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore.filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): PersistentVolumeClaim [] Parameters # Name Type namespace string | string [] strict? boolean Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore.getAllByNs getById # \u25b8 getById ( id ): undefined | PersistentVolumeClaim Parameters # Name Type id string Returns # undefined | PersistentVolumeClaim Inherited from # KubeObjectStore.getById getByLabel # \u25b8 getByLabel ( labels ): PersistentVolumeClaim [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore.getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | PersistentVolumeClaim Parameters # Name Type name string namespace? string Returns # undefined | PersistentVolumeClaim Inherited from # KubeObjectStore.getByName getByPath # \u25b8 getByPath ( path ): undefined | PersistentVolumeClaim Parameters # Name Type path string Returns # undefined | PersistentVolumeClaim Inherited from # KubeObjectStore.getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore.getIndexById getItems # \u25b8 getItems (): PersistentVolumeClaim [] Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore.getItems getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item PersistentVolumeClaim Returns # boolean Inherited from # KubeObjectStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems? PersistentVolumeClaim [] Returns # boolean Inherited from # KubeObjectStore.isSelectedAll load # \u25b8 load ( params ): Promise < PersistentVolumeClaim > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore.load loadAll # \u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PersistentVolumeClaim []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadAllParams Returns # Promise < undefined | PersistentVolumeClaim []> Inherited from # KubeObjectStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < PersistentVolumeClaim > Parameters # Name Type resourcePath string Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore.loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < null | PersistentVolumeClaim > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | PersistentVolumeClaim > Inherited from # KubeObjectStore.loadItem loadItems # \u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PersistentVolumeClaim []> Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreLoadingParams Returns # Promise < PersistentVolumeClaim []> Inherited from # KubeObjectStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PersistentVolumeClaim [] Parameters # Name Type partialItems PersistentVolumeClaim [] \u00abdestructured\u00bb MergeItemsOptions Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore.mergeItems patch # \u25b8 patch ( item , patch ): Promise < PersistentVolumeClaim > Parameters # Name Type item PersistentVolumeClaim patch Patch Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore.patch pickOnlySelected # \u25b8 pickOnlySelected ( items ): PersistentVolumeClaim [] Parameters # Name Type items PersistentVolumeClaim [] Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore.pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | PersistentVolumeClaim []> Parameters # Name Type opts? Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | PersistentVolumeClaim []> Inherited from # KubeObjectStore.reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item PersistentVolumeClaim Returns # Promise < void > Inherited from # KubeObjectStore.remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item PersistentVolumeClaim request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore.removeItem removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items PersistentVolumeClaim [] Returns # Promise < void > Inherited from # KubeObjectStore.removeItems removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void > Returns # Promise < void > Inherited from # KubeObjectStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore.resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item PersistentVolumeClaim Returns # void Inherited from # KubeObjectStore.select sortItems # \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). Parameters # Name Type Description 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\" ) Returns # PersistentVolumeClaim [] Inherited from # KubeObjectStore.sortItems subscribe # \u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer Parameters # Name Type \u00abdestructured\u00bb KubeObjectStoreSubscribeParams Returns # Disposer Inherited from # KubeObjectStore.subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item PersistentVolumeClaim Returns # void Inherited from # KubeObjectStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems? PersistentVolumeClaim [] Returns # void Inherited from # KubeObjectStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item PersistentVolumeClaim Returns # void Inherited from # KubeObjectStore.unselect update # \u25b8 update ( item , data ): Promise < PersistentVolumeClaim > Parameters # Name Type item PersistentVolumeClaim data PartialObjectDeep < PersistentVolumeClaim > Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore.update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore.updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < PersistentVolumeClaim > Parameters # Name Type item PersistentVolumeClaim request () => Promise < PersistentVolumeClaim > Returns # Promise < PersistentVolumeClaim > Inherited from # KubeObjectStore.updateItem","title":"Class: VolumeClaimStore"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#class-volumeclaimstore","text":"Renderer . K8sApi .VolumeClaimStore","title":"Class: VolumeClaimStore"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#hierarchy","text":"KubeObjectStore < PersistentVolumeClaim , PersistentVolumeClaimApi > \u21b3 VolumeClaimStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#properties","text":"api bufferSize defaultSorting dependencies eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#accessors","text":"contextItems query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#constructor","text":"\u2022 new VolumeClaimStore ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#api","text":"\u2022 Readonly api : PersistentVolumeClaimApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#defaultsorting","text":"\u2022 Protected defaultSorting : ( item : PersistentVolumeClaim ) => string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#dependencies","text":"\u2022 Protected Readonly dependencies : KubeObjectStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#eventsbuffer","text":"\u2022 Protected Readonly eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , PersistentVolumeClaimStatus , PersistentVolumeClaimSpec >>>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#failedloading","text":"\u2022 failedLoading : boolean","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isloaded","text":"\u2022 isLoaded : boolean","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isloading","text":"\u2022 isLoading : boolean","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#items","text":"\u2022 items : IObservableArray < PersistentVolumeClaim >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#limit","text":"\u2022 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#contextitems","text":"\u2022 get contextItems (): K []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#query","text":"\u2022 get query (): KubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#iterator","text":"\u25b8 [iterator] (): Generator < PersistentVolumeClaim , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#create","text":"\u25b8 create ( params , data? ): Promise < PersistentVolumeClaim >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < null | PersistentVolumeClaim >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): PersistentVolumeClaim []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): PersistentVolumeClaim []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbyid","text":"\u25b8 getById ( id ): undefined | PersistentVolumeClaim","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): PersistentVolumeClaim []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): undefined | PersistentVolumeClaim","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | PersistentVolumeClaim","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#getitems","text":"\u25b8 getItems (): PersistentVolumeClaim []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#load","text":"\u25b8 load ( params ): Promise < PersistentVolumeClaim >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loadall","text":"\u25b8 loadAll ( \u00abdestructured\u00bb? ): Promise < undefined | PersistentVolumeClaim []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < PersistentVolumeClaim >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < null | PersistentVolumeClaim >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#loaditems","text":"\u25b8 Protected loadItems ( \u00abdestructured\u00bb ): Promise < PersistentVolumeClaim []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , \u00abdestructured\u00bb ): PersistentVolumeClaim []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < PersistentVolumeClaim >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): PersistentVolumeClaim []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | PersistentVolumeClaim []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void >","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#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).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#subscribe","text":"\u25b8 subscribe ( \u00abdestructured\u00bb? ): Disposer","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#update","text":"\u25b8 update ( item , data ): Promise < PersistentVolumeClaim >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < PersistentVolumeClaim >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.LensExtension/","text":"Class: LensExtension # Renderer .LensExtension Hierarchy # LensExtension < LensRendererExtensionDependencies > \u21b3 LensExtension Table of contents # Constructors # constructor Properties # additionalCategoryColumns appPreferenceTabs appPreferences catalogEntityDetailItems clusterFrameComponents clusterPageMenus clusterPages commands customCategoryViews entitySettings globalPages id isBundled kubeObjectDetailItems kubeObjectHandlers kubeObjectMenuItems kubeObjectStatusTexts kubeWorkloadsOverviewItems manifest manifestPath protocolHandlers statusBarItems topBarItems welcomeBanners welcomeMenus Accessors # description isEnabled name sanitizedExtensionId storeName version Methods # activate addCatalogCategoryFilter addCatalogFilter disable enable getExtensionFileFolder isEnabledForCluster navigate onActivate onDeactivate Constructors # constructor # \u2022 new LensExtension ( \u00abdestructured\u00bb ) Parameters # Name Type \u00abdestructured\u00bb InstalledExtension Inherited from # LensExtension . constructor Properties # additionalCategoryColumns # \u2022 additionalCategoryColumns : AdditionalCategoryColumnRegistration [] appPreferenceTabs # \u2022 appPreferenceTabs : AppPreferenceTabRegistration [] appPreferences # \u2022 appPreferences : AppPreferenceRegistration [] catalogEntityDetailItems # \u2022 catalogEntityDetailItems : CatalogEntityDetailRegistration < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >>[] clusterFrameComponents # \u2022 clusterFrameComponents : ClusterFrameChildComponent [] clusterPageMenus # \u2022 clusterPageMenus : ClusterPageMenuRegistration [] clusterPages # \u2022 clusterPages : PageRegistration [] commands # \u2022 commands : CommandRegistration [] customCategoryViews # \u2022 customCategoryViews : CustomCategoryViewRegistration [] entitySettings # \u2022 entitySettings : EntitySettingRegistration [] globalPages # \u2022 globalPages : PageRegistration [] id # \u2022 Readonly id : string Inherited from # LensExtension . id isBundled # \u2022 Readonly isBundled : boolean Inherited from # LensExtension . isBundled kubeObjectDetailItems # \u2022 kubeObjectDetailItems : KubeObjectDetailRegistration < KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >>[] kubeObjectHandlers # \u2022 kubeObjectHandlers : KubeObjectHandlerRegistration [] kubeObjectMenuItems # \u2022 kubeObjectMenuItems : KubeObjectMenuRegistration [] kubeObjectStatusTexts # \u2022 kubeObjectStatusTexts : KubeObjectStatusRegistration [] kubeWorkloadsOverviewItems # \u2022 kubeWorkloadsOverviewItems : WorkloadsOverviewDetailRegistration [] manifest # \u2022 Readonly manifest : LensExtensionManifest Inherited from # LensExtension . manifest manifestPath # \u2022 Readonly manifestPath : string Inherited from # LensExtension . manifestPath protocolHandlers # \u2022 protocolHandlers : ProtocolHandlerRegistration [] Inherited from # LensExtension . protocolHandlers statusBarItems # \u2022 statusBarItems : StatusBarRegistration [] topBarItems # \u2022 topBarItems : TopBarRegistration [] welcomeBanners # \u2022 welcomeBanners : WelcomeBannerRegistration [] welcomeMenus # \u2022 welcomeMenus : WelcomeMenuRegistration [] Accessors # description # \u2022 get description (): undefined | string Returns # undefined | string Inherited from # LensExtension.description isEnabled # \u2022 get isEnabled (): boolean Returns # boolean Inherited from # LensExtension.isEnabled name # \u2022 get name (): string Returns # string Inherited from # LensExtension.name sanitizedExtensionId # \u2022 get sanitizedExtensionId (): string Returns # string Inherited from # LensExtension.sanitizedExtensionId storeName # \u2022 get storeName (): string Returns # string Inherited from # LensExtension.storeName version # \u2022 get version (): string Returns # string Inherited from # LensExtension.version Methods # activate # \u25b8 activate (): Promise < void > Returns # Promise < void > Inherited from # LensExtension . activate addCatalogCategoryFilter # \u25b8 addCatalogCategoryFilter ( fn ): Disposer Add a filtering function for the catalog categories. This will be removed if the extension is disabled. Parameters # Name Type Description fn CategoryFilter The function which should return a truthy value for those categories which should be kept. Returns # Disposer A function to clean up the filter addCatalogFilter # \u25b8 addCatalogFilter ( fn ): Disposer Add a filtering function for the catalog entities. This will be removed if the extension is disabled. Parameters # Name Type Description fn EntityFilter The function which should return a truthy value for those entities which should be kept. Returns # Disposer A function to clean up the filter disable # \u25b8 disable (): Promise < void > Returns # Promise < void > Inherited from # LensExtension . disable enable # \u25b8 enable (): Promise < void > Returns # Promise < void > Inherited from # LensExtension . enable getExtensionFileFolder # \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. Returns # Promise < string > Inherited from # LensExtension . getExtensionFileFolder isEnabledForCluster # \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 Parameters # Name Type cluster KubernetesCluster < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > Returns # Promise < Boolean > navigate # \u25b8 navigate ( pageId? , params? ): Promise < void > Parameters # Name Type pageId? string params? object Returns # Promise < void > onActivate # \u25b8 Protected onActivate (): void | Promise < void > Returns # void | Promise < void > Inherited from # LensExtension . onActivate onDeactivate # \u25b8 Protected onDeactivate (): void | Promise < void > Returns # void | Promise < void > Inherited from # LensExtension . onDeactivate","title":"Class: LensExtension"},{"location":"extensions/api/classes/Renderer.LensExtension/#class-lensextension","text":"Renderer .LensExtension","title":"Class: LensExtension"},{"location":"extensions/api/classes/Renderer.LensExtension/#hierarchy","text":"LensExtension < LensRendererExtensionDependencies > \u21b3 LensExtension","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.LensExtension/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.LensExtension/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.LensExtension/#properties","text":"additionalCategoryColumns appPreferenceTabs appPreferences catalogEntityDetailItems clusterFrameComponents clusterPageMenus clusterPages commands customCategoryViews entitySettings globalPages id isBundled kubeObjectDetailItems kubeObjectHandlers kubeObjectMenuItems kubeObjectStatusTexts kubeWorkloadsOverviewItems manifest manifestPath protocolHandlers statusBarItems topBarItems welcomeBanners welcomeMenus","title":"Properties"},{"location":"extensions/api/classes/Renderer.LensExtension/#accessors","text":"description isEnabled name sanitizedExtensionId storeName version","title":"Accessors"},{"location":"extensions/api/classes/Renderer.LensExtension/#methods","text":"activate addCatalogCategoryFilter addCatalogFilter disable enable getExtensionFileFolder isEnabledForCluster navigate onActivate onDeactivate","title":"Methods"},{"location":"extensions/api/classes/Renderer.LensExtension/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.LensExtension/#constructor","text":"\u2022 new LensExtension ( \u00abdestructured\u00bb )","title":"constructor"},{"location":"extensions/api/classes/Renderer.LensExtension/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.LensExtension/#additionalcategorycolumns","text":"\u2022 additionalCategoryColumns : AdditionalCategoryColumnRegistration []","title":"additionalCategoryColumns"},{"location":"extensions/api/classes/Renderer.LensExtension/#apppreferencetabs","text":"\u2022 appPreferenceTabs : AppPreferenceTabRegistration []","title":"appPreferenceTabs"},{"location":"extensions/api/classes/Renderer.LensExtension/#apppreferences","text":"\u2022 appPreferences : AppPreferenceRegistration []","title":"appPreferences"},{"location":"extensions/api/classes/Renderer.LensExtension/#catalogentitydetailitems","text":"\u2022 catalogEntityDetailItems : CatalogEntityDetailRegistration < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >>[]","title":"catalogEntityDetailItems"},{"location":"extensions/api/classes/Renderer.LensExtension/#clusterframecomponents","text":"\u2022 clusterFrameComponents : ClusterFrameChildComponent []","title":"clusterFrameComponents"},{"location":"extensions/api/classes/Renderer.LensExtension/#clusterpagemenus","text":"\u2022 clusterPageMenus : ClusterPageMenuRegistration []","title":"clusterPageMenus"},{"location":"extensions/api/classes/Renderer.LensExtension/#clusterpages","text":"\u2022 clusterPages : PageRegistration []","title":"clusterPages"},{"location":"extensions/api/classes/Renderer.LensExtension/#commands","text":"\u2022 commands : CommandRegistration []","title":"commands"},{"location":"extensions/api/classes/Renderer.LensExtension/#customcategoryviews","text":"\u2022 customCategoryViews : CustomCategoryViewRegistration []","title":"customCategoryViews"},{"location":"extensions/api/classes/Renderer.LensExtension/#entitysettings","text":"\u2022 entitySettings : EntitySettingRegistration []","title":"entitySettings"},{"location":"extensions/api/classes/Renderer.LensExtension/#globalpages","text":"\u2022 globalPages : PageRegistration []","title":"globalPages"},{"location":"extensions/api/classes/Renderer.LensExtension/#id","text":"\u2022 Readonly id : string","title":"id"},{"location":"extensions/api/classes/Renderer.LensExtension/#isbundled","text":"\u2022 Readonly isBundled : boolean","title":"isBundled"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjectdetailitems","text":"\u2022 kubeObjectDetailItems : KubeObjectDetailRegistration < KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >>[]","title":"kubeObjectDetailItems"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjecthandlers","text":"\u2022 kubeObjectHandlers : KubeObjectHandlerRegistration []","title":"kubeObjectHandlers"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjectmenuitems","text":"\u2022 kubeObjectMenuItems : KubeObjectMenuRegistration []","title":"kubeObjectMenuItems"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeobjectstatustexts","text":"\u2022 kubeObjectStatusTexts : KubeObjectStatusRegistration []","title":"kubeObjectStatusTexts"},{"location":"extensions/api/classes/Renderer.LensExtension/#kubeworkloadsoverviewitems","text":"\u2022 kubeWorkloadsOverviewItems : WorkloadsOverviewDetailRegistration []","title":"kubeWorkloadsOverviewItems"},{"location":"extensions/api/classes/Renderer.LensExtension/#manifest","text":"\u2022 Readonly manifest : LensExtensionManifest","title":"manifest"},{"location":"extensions/api/classes/Renderer.LensExtension/#manifestpath","text":"\u2022 Readonly manifestPath : string","title":"manifestPath"},{"location":"extensions/api/classes/Renderer.LensExtension/#protocolhandlers","text":"\u2022 protocolHandlers : ProtocolHandlerRegistration []","title":"protocolHandlers"},{"location":"extensions/api/classes/Renderer.LensExtension/#statusbaritems","text":"\u2022 statusBarItems : StatusBarRegistration []","title":"statusBarItems"},{"location":"extensions/api/classes/Renderer.LensExtension/#topbaritems","text":"\u2022 topBarItems : TopBarRegistration []","title":"topBarItems"},{"location":"extensions/api/classes/Renderer.LensExtension/#welcomebanners","text":"\u2022 welcomeBanners : WelcomeBannerRegistration []","title":"welcomeBanners"},{"location":"extensions/api/classes/Renderer.LensExtension/#welcomemenus","text":"\u2022 welcomeMenus : WelcomeMenuRegistration []","title":"welcomeMenus"},{"location":"extensions/api/classes/Renderer.LensExtension/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.LensExtension/#description","text":"\u2022 get description (): undefined | string","title":"description"},{"location":"extensions/api/classes/Renderer.LensExtension/#isenabled","text":"\u2022 get isEnabled (): boolean","title":"isEnabled"},{"location":"extensions/api/classes/Renderer.LensExtension/#name","text":"\u2022 get name (): string","title":"name"},{"location":"extensions/api/classes/Renderer.LensExtension/#sanitizedextensionid","text":"\u2022 get sanitizedExtensionId (): string","title":"sanitizedExtensionId"},{"location":"extensions/api/classes/Renderer.LensExtension/#storename","text":"\u2022 get storeName (): string","title":"storeName"},{"location":"extensions/api/classes/Renderer.LensExtension/#version","text":"\u2022 get version (): string","title":"version"},{"location":"extensions/api/classes/Renderer.LensExtension/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.LensExtension/#activate","text":"\u25b8 activate (): Promise < void >","title":"activate"},{"location":"extensions/api/classes/Renderer.LensExtension/#addcatalogcategoryfilter","text":"\u25b8 addCatalogCategoryFilter ( fn ): Disposer Add a filtering function for the catalog categories. This will be removed if the extension is disabled.","title":"addCatalogCategoryFilter"},{"location":"extensions/api/classes/Renderer.LensExtension/#addcatalogfilter","text":"\u25b8 addCatalogFilter ( fn ): Disposer Add a filtering function for the catalog entities. This will be removed if the extension is disabled.","title":"addCatalogFilter"},{"location":"extensions/api/classes/Renderer.LensExtension/#disable","text":"\u25b8 disable (): Promise < void >","title":"disable"},{"location":"extensions/api/classes/Renderer.LensExtension/#enable","text":"\u25b8 enable (): Promise < void >","title":"enable"},{"location":"extensions/api/classes/Renderer.LensExtension/#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.","title":"getExtensionFileFolder"},{"location":"extensions/api/classes/Renderer.LensExtension/#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","title":"isEnabledForCluster"},{"location":"extensions/api/classes/Renderer.LensExtension/#navigate","text":"\u25b8 navigate ( pageId? , params? ): Promise < void >","title":"navigate"},{"location":"extensions/api/classes/Renderer.LensExtension/#onactivate","text":"\u25b8 Protected onActivate (): void | Promise < void >","title":"onActivate"},{"location":"extensions/api/classes/Renderer.LensExtension/#ondeactivate","text":"\u25b8 Protected onDeactivate (): void | Promise < void >","title":"onDeactivate"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/","text":"Class: PageParam # Renderer . Navigation .PageParam Type parameters # Name Type Value any Table of contents # Constructors # constructor Properties # dependencies isMulti name Accessors # defaultValue Methods # clear get getRaw parse set setRaw stringify toString Constructors # constructor # \u2022 new PageParam < Value >( dependencies , init ) Type parameters # Name Type Value any Parameters # Name Type dependencies PageParamDependencies init PageParamInit < Value > Properties # dependencies # \u2022 Protected Readonly dependencies : PageParamDependencies isMulti # \u2022 Readonly isMulti : boolean name # \u2022 Readonly name : string Accessors # defaultValue # \u2022 get defaultValue (): undefined | Value Returns # undefined | Value Methods # clear # \u25b8 clear (): void Returns # void get # \u25b8 get (): Value Returns # Value getRaw # \u25b8 getRaw (): string | string [] Get stringified raw value(s) from document.location.search Returns # string | string [] parse # \u25b8 parse ( values ): Value Parameters # Name Type values string | string [] Returns # Value set # \u25b8 set ( value , \u00abdestructured\u00bb? ): void Parameters # Name Type value Value \u00abdestructured\u00bb Object \u203a mergeGlobals? boolean \u203a replaceHistory? boolean Returns # void setRaw # \u25b8 setRaw ( value ): void Set stringified raw value(s) and update document.location.search Parameters # Name Type value string | string [] Returns # void stringify # \u25b8 stringify ( value? ): string [] Parameters # Name Type value? Value Returns # string [] toString # \u25b8 toString ( \u00abdestructured\u00bb? ): string Parameters # Name Type \u00abdestructured\u00bb Object \u203a mergeGlobals? boolean \u203a value? Value Returns # string","title":"Class: PageParam"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#class-pageparamvalue","text":"Renderer . Navigation .PageParam","title":"Class: PageParam<Value>"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#type-parameters","text":"Name Type Value any","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#properties","text":"dependencies isMulti name","title":"Properties"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#accessors","text":"defaultValue","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#methods","text":"clear get getRaw parse set setRaw stringify toString","title":"Methods"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#constructor","text":"\u2022 new PageParam < Value >( dependencies , init )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#dependencies","text":"\u2022 Protected Readonly dependencies : PageParamDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#ismulti","text":"\u2022 Readonly isMulti : boolean","title":"isMulti"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#name","text":"\u2022 Readonly name : string","title":"name"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#defaultvalue","text":"\u2022 get defaultValue (): undefined | Value","title":"defaultValue"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#clear","text":"\u25b8 clear (): void","title":"clear"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#get","text":"\u25b8 get (): Value","title":"get"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#getraw","text":"\u25b8 getRaw (): string | string [] Get stringified raw value(s) from document.location.search","title":"getRaw"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#parse","text":"\u25b8 parse ( values ): Value","title":"parse"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#set","text":"\u25b8 set ( value , \u00abdestructured\u00bb? ): void","title":"set"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#setraw","text":"\u25b8 setRaw ( value ): void Set stringified raw value(s) and update document.location.search","title":"setRaw"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#stringify","text":"\u25b8 stringify ( value? ): string []","title":"stringify"},{"location":"extensions/api/classes/Renderer.Navigation.PageParam/#tostring","text":"\u25b8 toString ( \u00abdestructured\u00bb? ): string","title":"toString"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/","text":"Enumeration: NotificationStatus # Renderer . Component .NotificationStatus Table of contents # Enumeration Members # ERROR INFO OK Enumeration Members # ERROR # \u2022 ERROR = \"error\" INFO # \u2022 INFO = \"info\" OK # \u2022 OK = \"ok\"","title":"Enumeration: NotificationStatus"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#enumeration-notificationstatus","text":"Renderer . Component .NotificationStatus","title":"Enumeration: NotificationStatus"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#enumeration-members","text":"ERROR INFO OK","title":"Enumeration Members"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#enumeration-members_1","text":"","title":"Enumeration Members"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#error","text":"\u2022 ERROR = \"error\"","title":"ERROR"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#info","text":"\u2022 INFO = \"info\"","title":"INFO"},{"location":"extensions/api/enums/Renderer.Component.NotificationStatus/#ok","text":"\u2022 OK = \"ok\"","title":"OK"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/","text":"Enumeration: TooltipPosition # Renderer . Component .TooltipPosition Table of contents # Enumeration Members # BOTTOM BOTTOM_LEFT BOTTOM_RIGHT LEFT RIGHT TOP TOP_LEFT TOP_RIGHT Enumeration Members # BOTTOM # \u2022 BOTTOM = \"bottom\" BOTTOM_LEFT # \u2022 BOTTOM_LEFT = \"bottom_left\" BOTTOM_RIGHT # \u2022 BOTTOM_RIGHT = \"bottom_right\" LEFT # \u2022 LEFT = \"left\" RIGHT # \u2022 RIGHT = \"right\" TOP # \u2022 TOP = \"top\" TOP_LEFT # \u2022 TOP_LEFT = \"top_left\" TOP_RIGHT # \u2022 TOP_RIGHT = \"top_right\"","title":"Enumeration: TooltipPosition"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#enumeration-tooltipposition","text":"Renderer . Component .TooltipPosition","title":"Enumeration: TooltipPosition"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#enumeration-members","text":"BOTTOM BOTTOM_LEFT BOTTOM_RIGHT LEFT RIGHT TOP TOP_LEFT TOP_RIGHT","title":"Enumeration Members"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#enumeration-members_1","text":"","title":"Enumeration Members"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#bottom","text":"\u2022 BOTTOM = \"bottom\"","title":"BOTTOM"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#bottom_left","text":"\u2022 BOTTOM_LEFT = \"bottom_left\"","title":"BOTTOM_LEFT"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#bottom_right","text":"\u2022 BOTTOM_RIGHT = \"bottom_right\"","title":"BOTTOM_RIGHT"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#left","text":"\u2022 LEFT = \"left\"","title":"LEFT"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#right","text":"\u2022 RIGHT = \"right\"","title":"RIGHT"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#top","text":"\u2022 TOP = \"top\"","title":"TOP"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#top_left","text":"\u2022 TOP_LEFT = \"top_left\"","title":"TOP_LEFT"},{"location":"extensions/api/enums/Renderer.Component.TooltipPosition/#top_right","text":"\u2022 TOP_RIGHT = \"top_right\"","title":"TOP_RIGHT"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/","text":"Enumeration: KubeObjectStatusLevel # Renderer . K8sApi .KubeObjectStatusLevel Table of contents # Enumeration Members # CRITICAL INFO WARNING Enumeration Members # CRITICAL # \u2022 CRITICAL = 3 INFO # \u2022 INFO = 1 WARNING # \u2022 WARNING = 2","title":"Enumeration: KubeObjectStatusLevel"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#enumeration-kubeobjectstatuslevel","text":"Renderer . K8sApi .KubeObjectStatusLevel","title":"Enumeration: KubeObjectStatusLevel"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#enumeration-members","text":"CRITICAL INFO WARNING","title":"Enumeration Members"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#enumeration-members_1","text":"","title":"Enumeration Members"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#critical","text":"\u2022 CRITICAL = 3","title":"CRITICAL"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#info","text":"\u2022 INFO = 1","title":"INFO"},{"location":"extensions/api/enums/Renderer.K8sApi.KubeObjectStatusLevel/#warning","text":"\u2022 WARNING = 2","title":"WARNING"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/","text":"Interface: CatalogCategoryEvents # Common . Catalog .CatalogCategoryEvents Table of contents # Properties # catalogAddMenu contextMenuOpen load Properties # catalogAddMenu # \u2022 catalogAddMenu : ( context : CatalogEntityAddMenuContext ) => void Type declaration # \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. Parameters # Name Type context CatalogEntityAddMenuContext Returns # void contextMenuOpen # \u2022 contextMenuOpen : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >, context : CatalogEntityContextMenuContext ) => void Type declaration # \u25b8 ( entity , context ): void This event will be emitted when the context menu for an entity is declared by this category is opened. Parameters # Name Type entity CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > context CatalogEntityContextMenuContext Returns # void load # \u2022 load : () => void Type declaration # \u25b8 (): void This event will be emitted when the category is loaded in the catalog view. Returns # void","title":"Interface: CatalogCategoryEvents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#interface-catalogcategoryevents","text":"Common . Catalog .CatalogCategoryEvents","title":"Interface: CatalogCategoryEvents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#properties","text":"catalogAddMenu contextMenuOpen load","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#catalogaddmenu","text":"\u2022 catalogAddMenu : ( context : CatalogEntityAddMenuContext ) => void","title":"catalogAddMenu"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#contextmenuopen","text":"\u2022 contextMenuOpen : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >, context : CatalogEntityContextMenuContext ) => void","title":"contextMenuOpen"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryEvents/#load","text":"\u2022 load : () => void","title":"load"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/","text":"Interface: CatalogCategoryMetadata # Common . Catalog .CatalogCategoryMetadata Table of contents # Properties # icon name Properties # icon # \u2022 Readonly icon : string Either an or the name of an icon from IconProps name # \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.","title":"Interface: CatalogCategoryMetadata"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#interface-catalogcategorymetadata","text":"Common . Catalog .CatalogCategoryMetadata","title":"Interface: CatalogCategoryMetadata"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#properties","text":"icon name","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#icon","text":"\u2022 Readonly icon : string Either an or the name of an icon from IconProps","title":"icon"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryMetadata/#name","text":"\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.","title":"name"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/","text":"Interface: CatalogCategorySpec # Common . Catalog .CatalogCategorySpec Table of contents # Properties # displayColumns group names versions Properties # displayColumns # \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. group # \u2022 Readonly group : string The grouping for for the category. This MUST be a DNS label. names # \u2022 Readonly names : Object This is the concerning the category Type declaration # Name Type Description kind 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. versions # \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","title":"Interface: CatalogCategorySpec"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#interface-catalogcategoryspec","text":"Common . Catalog .CatalogCategorySpec","title":"Interface: CatalogCategorySpec"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#properties","text":"displayColumns group names versions","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#displaycolumns","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.","title":"displayColumns"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#group","text":"\u2022 Readonly group : string The grouping for for the category. This MUST be a DNS label.","title":"group"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#names","text":"\u2022 Readonly names : Object This is the concerning the category","title":"names"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategorySpec/#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","title":"versions"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/","text":"Interface: CatalogCategoryVersion # Common . Catalog .CatalogCategoryVersion Table of contents # Properties # entityClass name Properties # entityClass # \u2022 Readonly entityClass : CatalogEntityConstructor < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >> The constructor for the entities. name # \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","title":"Interface: CatalogCategoryVersion"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#interface-catalogcategoryversion","text":"Common . Catalog .CatalogCategoryVersion","title":"Interface: CatalogCategoryVersion"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#properties","text":"entityClass name","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#entityclass","text":"\u2022 Readonly entityClass : CatalogEntityConstructor < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >> The constructor for the entities.","title":"entityClass"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogCategoryVersion/#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","title":"name"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/","text":"Interface: CatalogEntityActionContext # Common . Catalog .CatalogEntityActionContext Table of contents # Properties # navigate setCommandPaletteContext Properties # navigate # \u2022 navigate : ( url : string ) => void Type declaration # \u25b8 ( url ): void Parameters # Name Type url string Returns # void setCommandPaletteContext # \u2022 setCommandPaletteContext : ( context? : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => void Type declaration # \u25b8 ( context? ): void Parameters # Name Type context? CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Returns # void","title":"Interface: CatalogEntityActionContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#interface-catalogentityactioncontext","text":"Common . Catalog .CatalogEntityActionContext","title":"Interface: CatalogEntityActionContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#properties","text":"navigate setCommandPaletteContext","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#navigate","text":"\u2022 navigate : ( url : string ) => void","title":"navigate"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityActionContext/#setcommandpalettecontext","text":"\u2022 setCommandPaletteContext : ( context? : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => void","title":"setCommandPaletteContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/","text":"Interface: CatalogEntityAddMenu # Common . Catalog .CatalogEntityAddMenu Hierarchy # CatalogEntityContextMenu \u21b3 CatalogEntityAddMenu Table of contents # Properties # confirm defaultAction icon onClick title Properties # confirm # \u2022 Optional confirm : Object Confirm click with a message Type declaration # Name Type message string Inherited from # CatalogEntityContextMenu . confirm defaultAction # \u2022 Optional defaultAction : boolean icon # \u2022 icon : string Menu icon Overrides # CatalogEntityContextMenu . icon onClick # \u2022 onClick : () => void | Promise < void > Type declaration # \u25b8 (): void | Promise < void > OnClick handler Returns # void | Promise < void > Inherited from # CatalogEntityContextMenu . onClick title # \u2022 title : string Menu title Inherited from # CatalogEntityContextMenu . title","title":"Interface: CatalogEntityAddMenu"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#interface-catalogentityaddmenu","text":"Common . Catalog .CatalogEntityAddMenu","title":"Interface: CatalogEntityAddMenu"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#hierarchy","text":"CatalogEntityContextMenu \u21b3 CatalogEntityAddMenu","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#properties","text":"confirm defaultAction icon onClick title","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#confirm","text":"\u2022 Optional confirm : Object Confirm click with a message","title":"confirm"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#defaultaction","text":"\u2022 Optional defaultAction : boolean","title":"defaultAction"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#icon","text":"\u2022 icon : string Menu icon","title":"icon"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#onclick","text":"\u2022 onClick : () => void | Promise < void >","title":"onClick"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenu/#title","text":"\u2022 title : string Menu title","title":"title"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/","text":"Interface: CatalogEntityAddMenuContext # Common . Catalog .CatalogEntityAddMenuContext Table of contents # Properties # menuItems navigate Properties # menuItems # \u2022 menuItems : CatalogEntityAddMenu [] navigate # \u2022 navigate : ( url : string ) => void Type declaration # \u25b8 ( url ): void Parameters # Name Type url string Returns # void","title":"Interface: CatalogEntityAddMenuContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#interface-catalogentityaddmenucontext","text":"Common . Catalog .CatalogEntityAddMenuContext","title":"Interface: CatalogEntityAddMenuContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#properties","text":"menuItems navigate","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#menuitems","text":"\u2022 menuItems : CatalogEntityAddMenu []","title":"menuItems"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityAddMenuContext/#navigate","text":"\u2022 navigate : ( url : string ) => void","title":"navigate"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/","text":"Interface: CatalogEntityContextMenu # Common . Catalog .CatalogEntityContextMenu Hierarchy # CatalogEntityContextMenu \u21b3 CatalogEntityAddMenu Table of contents # Properties # confirm icon onClick title Properties # confirm # \u2022 Optional confirm : Object Confirm click with a message Type declaration # Name Type message string icon # \u2022 Optional icon : string Menu icon onClick # \u2022 onClick : () => void | Promise < void > Type declaration # \u25b8 (): void | Promise < void > OnClick handler Returns # void | Promise < void > title # \u2022 title : string Menu title","title":"Interface: CatalogEntityContextMenu"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#interface-catalogentitycontextmenu","text":"Common . Catalog .CatalogEntityContextMenu","title":"Interface: CatalogEntityContextMenu"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#hierarchy","text":"CatalogEntityContextMenu \u21b3 CatalogEntityAddMenu","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#properties","text":"confirm icon onClick title","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#confirm","text":"\u2022 Optional confirm : Object Confirm click with a message","title":"confirm"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#icon","text":"\u2022 Optional icon : string Menu icon","title":"icon"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#onclick","text":"\u2022 onClick : () => void | Promise < void >","title":"onClick"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenu/#title","text":"\u2022 title : string Menu title","title":"title"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/","text":"Interface: CatalogEntityContextMenuContext # Common . Catalog .CatalogEntityContextMenuContext Table of contents # Properties # menuItems navigate Properties # menuItems # \u2022 menuItems : CatalogEntityContextMenu [] navigate # \u2022 navigate : CatalogEntityContextMenuNavigate Navigate to the specified pathname","title":"Interface: CatalogEntityContextMenuContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#interface-catalogentitycontextmenucontext","text":"Common . Catalog .CatalogEntityContextMenuContext","title":"Interface: CatalogEntityContextMenuContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#properties","text":"menuItems navigate","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#menuitems","text":"\u2022 menuItems : CatalogEntityContextMenu []","title":"menuItems"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuContext/#navigate","text":"\u2022 navigate : CatalogEntityContextMenuNavigate Navigate to the specified pathname","title":"navigate"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/","text":"Interface: CatalogEntityContextMenuNavigate # Common . Catalog .CatalogEntityContextMenuNavigate Callable # CatalogEntityContextMenuNavigate # \u25b8 CatalogEntityContextMenuNavigate ( pathname , forceMainFrame? ): void Parameters # Name Type Description pathname string The location to navigate to in the main iframe forceMainFrame? boolean - Returns # void CatalogEntityContextMenuNavigate # \u25b8 CatalogEntityContextMenuNavigate ( pathname , forceMainFrame ): void Parameters # Name Type Description pathname string The location to navigate to in the current iframe. Useful for when called within the cluster frame forceMainFrame false - Returns # void","title":"Interface: CatalogEntityContextMenuNavigate"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#interface-catalogentitycontextmenunavigate","text":"Common . Catalog .CatalogEntityContextMenuNavigate","title":"Interface: CatalogEntityContextMenuNavigate"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#callable","text":"","title":"Callable"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#catalogentitycontextmenunavigate","text":"\u25b8 CatalogEntityContextMenuNavigate ( pathname , forceMainFrame? ): void","title":"CatalogEntityContextMenuNavigate"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityContextMenuNavigate/#catalogentitycontextmenunavigate_1","text":"\u25b8 CatalogEntityContextMenuNavigate ( pathname , forceMainFrame ): void","title":"CatalogEntityContextMenuNavigate"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/","text":"Interface: CatalogEntityData # Common . Catalog .CatalogEntityData Type parameters # Name Type Metadata extends CatalogEntityMetadata = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec Table of contents # Properties # metadata spec status Properties # metadata # \u2022 metadata : Metadata spec # \u2022 spec : Spec status # \u2022 status : Status","title":"Interface: CatalogEntityData"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#interface-catalogentitydatametadata-status-spec","text":"Common . Catalog .CatalogEntityData","title":"Interface: CatalogEntityData<Metadata, Status, Spec>"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#type-parameters","text":"Name Type Metadata extends CatalogEntityMetadata = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec","title":"Type parameters"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#properties","text":"metadata spec status","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#spec","text":"\u2022 spec : Spec","title":"spec"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityData/#status","text":"\u2022 status : Status","title":"status"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/","text":"Interface: CatalogEntityKindData # Common . Catalog .CatalogEntityKindData Implemented by # CatalogEntity Table of contents # Properties # apiVersion kind Properties # apiVersion # \u2022 Readonly apiVersion : string kind # \u2022 Readonly kind : string","title":"Interface: CatalogEntityKindData"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#interface-catalogentitykinddata","text":"Common . Catalog .CatalogEntityKindData","title":"Interface: CatalogEntityKindData"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#implemented-by","text":"CatalogEntity","title":"Implemented by"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#properties","text":"apiVersion kind","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#apiversion","text":"\u2022 Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityKindData/#kind","text":"\u2022 Readonly kind : string","title":"kind"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/","text":"Interface: CatalogEntityMetadata # Common . Catalog .CatalogEntityMetadata Hierarchy # EntityMetadataObject \u21b3 CatalogEntityMetadata \u21b3\u21b3 KubernetesClusterMetadata Table of contents # Properties # description labels name shortName source uid Properties # description # \u2022 Optional description : string labels # \u2022 labels : Record < string , string > name # \u2022 name : string shortName # \u2022 Optional shortName : string source # \u2022 Optional source : string uid # \u2022 uid : string","title":"Interface: CatalogEntityMetadata"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#interface-catalogentitymetadata","text":"Common . Catalog .CatalogEntityMetadata","title":"Interface: CatalogEntityMetadata"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#hierarchy","text":"EntityMetadataObject \u21b3 CatalogEntityMetadata \u21b3\u21b3 KubernetesClusterMetadata","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#properties","text":"description labels name shortName source uid","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#description","text":"\u2022 Optional description : string","title":"description"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#labels","text":"\u2022 labels : Record < string , string >","title":"labels"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#shortname","text":"\u2022 Optional shortName : string","title":"shortName"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#source","text":"\u2022 Optional source : string","title":"source"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityMetadata/#uid","text":"\u2022 uid : string","title":"uid"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/","text":"Interface: CatalogEntitySettingsContext # Common . Catalog .CatalogEntitySettingsContext Table of contents # Properties # menuItems Properties # menuItems # \u2022 menuItems : CatalogEntityContextMenu []","title":"Interface: CatalogEntitySettingsContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#interface-catalogentitysettingscontext","text":"Common . Catalog .CatalogEntitySettingsContext","title":"Interface: CatalogEntitySettingsContext"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#properties","text":"menuItems","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsContext/#menuitems","text":"\u2022 menuItems : CatalogEntityContextMenu []","title":"menuItems"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/","text":"Interface: CatalogEntitySettingsMenu # Common . Catalog .CatalogEntitySettingsMenu Table of contents # Properties # components group title Properties # components # \u2022 components : Object Type declaration # Name Type View ComponentType < any > group # \u2022 Optional group : string title # \u2022 title : string","title":"Interface: CatalogEntitySettingsMenu"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#interface-catalogentitysettingsmenu","text":"Common . Catalog .CatalogEntitySettingsMenu","title":"Interface: CatalogEntitySettingsMenu"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#properties","text":"components group title","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#components","text":"\u2022 components : Object","title":"components"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#group","text":"\u2022 Optional group : string","title":"group"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntitySettingsMenu/#title","text":"\u2022 title : string","title":"title"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/","text":"Interface: CatalogEntityStatus # Common . Catalog .CatalogEntityStatus Hierarchy # CatalogEntityStatus \u21b3 WebLinkStatus \u21b3 KubernetesClusterStatus Table of contents # Properties # active enabled message phase reason Properties # active # \u2022 Optional active : boolean enabled # \u2022 Optional enabled : boolean Default true message # \u2022 Optional message : string phase # \u2022 phase : string reason # \u2022 Optional reason : string","title":"Interface: CatalogEntityStatus"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#interface-catalogentitystatus","text":"Common . Catalog .CatalogEntityStatus","title":"Interface: CatalogEntityStatus"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#hierarchy","text":"CatalogEntityStatus \u21b3 WebLinkStatus \u21b3 KubernetesClusterStatus","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#properties","text":"active enabled message phase reason","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#enabled","text":"\u2022 Optional enabled : boolean Default true","title":"enabled"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#message","text":"\u2022 Optional message : string","title":"message"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#phase","text":"\u2022 phase : string","title":"phase"},{"location":"extensions/api/interfaces/Common.Catalog.CatalogEntityStatus/#reason","text":"\u2022 Optional reason : string","title":"reason"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/","text":"Interface: CategoryColumnRegistration # Common . Catalog .CategoryColumnRegistration Hierarchy # CategoryColumnRegistration \u21b3 AdditionalCategoryColumnRegistration Table of contents # Properties # id priority renderCell searchFilter sortCallback titleProps Properties # id # \u2022 id : string This value MUST to be unique to your extension priority # \u2022 Optional priority : number The sorting order value. Default 50 renderCell # \u2022 renderCell : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => ReactNode Type declaration # \u25b8 ( entity ): ReactNode This function will be called to generate the cells (on demand) for the column Parameters # Name Type entity CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Returns # ReactNode searchFilter # \u2022 Optional searchFilter : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | string [] Type declaration # \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. Parameters # Name Type entity CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Returns # string | string [] sortCallback # \u2022 Optional sortCallback : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | number | ( string | number )[] Type declaration # \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. Parameters # Name Type entity CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Returns # string | number | ( string | number )[] titleProps # \u2022 titleProps : TitleCellProps This function will be used to generate the columns title cell.","title":"Interface: CategoryColumnRegistration"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#interface-categorycolumnregistration","text":"Common . Catalog .CategoryColumnRegistration","title":"Interface: CategoryColumnRegistration"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#hierarchy","text":"CategoryColumnRegistration \u21b3 AdditionalCategoryColumnRegistration","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#properties","text":"id priority renderCell searchFilter sortCallback titleProps","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#id","text":"\u2022 id : string This value MUST to be unique to your extension","title":"id"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#priority","text":"\u2022 Optional priority : number The sorting order value. Default 50","title":"priority"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#rendercell","text":"\u2022 renderCell : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => ReactNode","title":"renderCell"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#searchfilter","text":"\u2022 Optional searchFilter : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | string []","title":"searchFilter"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#sortcallback","text":"\u2022 Optional sortCallback : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | number | ( string | number )[]","title":"sortCallback"},{"location":"extensions/api/interfaces/Common.Catalog.CategoryColumnRegistration/#titleprops","text":"\u2022 titleProps : TitleCellProps This function will be used to generate the columns title cell.","title":"titleProps"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/","text":"Interface: GeneralEntitySpec # Common . Catalog .GeneralEntitySpec Hierarchy # CatalogEntitySpec \u21b3 GeneralEntitySpec Table of contents # Properties # icon path Properties # icon # \u2022 Optional icon : Object Type declaration # Name Type background? string material? string path # \u2022 path : string","title":"Interface: GeneralEntitySpec"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#interface-generalentityspec","text":"Common . Catalog .GeneralEntitySpec","title":"Interface: GeneralEntitySpec"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#hierarchy","text":"CatalogEntitySpec \u21b3 GeneralEntitySpec","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#properties","text":"icon path","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#icon","text":"\u2022 Optional icon : Object","title":"icon"},{"location":"extensions/api/interfaces/Common.Catalog.GeneralEntitySpec/#path","text":"\u2022 path : string","title":"path"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/","text":"Interface: KubernetesClusterMetadata # Common . Catalog .KubernetesClusterMetadata Hierarchy # CatalogEntityMetadata \u21b3 KubernetesClusterMetadata Table of contents # Properties # description distro kubeVersion labels name shortName source uid Properties # description # \u2022 Optional description : string Inherited from # CatalogEntityMetadata . description distro # \u2022 Optional distro : string kubeVersion # \u2022 Optional kubeVersion : string labels # \u2022 labels : Record < string , string > Inherited from # CatalogEntityMetadata . labels name # \u2022 name : string Inherited from # CatalogEntityMetadata . name shortName # \u2022 Optional shortName : string Inherited from # CatalogEntityMetadata . shortName source # \u2022 Optional source : string Inherited from # CatalogEntityMetadata . source uid # \u2022 uid : string Inherited from # CatalogEntityMetadata . uid","title":"Interface: KubernetesClusterMetadata"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#interface-kubernetesclustermetadata","text":"Common . Catalog .KubernetesClusterMetadata","title":"Interface: KubernetesClusterMetadata"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#hierarchy","text":"CatalogEntityMetadata \u21b3 KubernetesClusterMetadata","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#properties","text":"description distro kubeVersion labels name shortName source uid","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#description","text":"\u2022 Optional description : string","title":"description"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#distro","text":"\u2022 Optional distro : string","title":"distro"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#kubeversion","text":"\u2022 Optional kubeVersion : string","title":"kubeVersion"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#labels","text":"\u2022 labels : Record < string , string >","title":"labels"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#shortname","text":"\u2022 Optional shortName : string","title":"shortName"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#source","text":"\u2022 Optional source : string","title":"source"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterMetadata/#uid","text":"\u2022 uid : string","title":"uid"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/","text":"Interface: KubernetesClusterPrometheusMetrics # Common . Catalog .KubernetesClusterPrometheusMetrics Table of contents # Properties # address type Properties # address # \u2022 Optional address : Object Type declaration # Name Type namespace string port number prefix string service string type # \u2022 Optional type : string","title":"Interface: KubernetesClusterPrometheusMetrics"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#interface-kubernetesclusterprometheusmetrics","text":"Common . Catalog .KubernetesClusterPrometheusMetrics","title":"Interface: KubernetesClusterPrometheusMetrics"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#properties","text":"address type","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#address","text":"\u2022 Optional address : Object","title":"address"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterPrometheusMetrics/#type","text":"\u2022 Optional type : string","title":"type"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/","text":"Interface: KubernetesClusterSpec # Common . Catalog .KubernetesClusterSpec Hierarchy # CatalogEntitySpec \u21b3 KubernetesClusterSpec Table of contents # Properties # accessibleNamespaces icon kubeconfigContext kubeconfigPath metrics Properties # accessibleNamespaces # \u2022 Optional accessibleNamespaces : string [] icon # \u2022 Optional icon : Object Type declaration # Name Type background? string material? string src? string kubeconfigContext # \u2022 kubeconfigContext : string kubeconfigPath # \u2022 kubeconfigPath : string metrics # \u2022 Optional metrics : Object Type declaration # Name Type prometheus? KubernetesClusterPrometheusMetrics source string","title":"Interface: KubernetesClusterSpec"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#interface-kubernetesclusterspec","text":"Common . Catalog .KubernetesClusterSpec","title":"Interface: KubernetesClusterSpec"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#hierarchy","text":"CatalogEntitySpec \u21b3 KubernetesClusterSpec","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#properties","text":"accessibleNamespaces icon kubeconfigContext kubeconfigPath metrics","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#accessiblenamespaces","text":"\u2022 Optional accessibleNamespaces : string []","title":"accessibleNamespaces"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#icon","text":"\u2022 Optional icon : Object","title":"icon"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#kubeconfigcontext","text":"\u2022 kubeconfigContext : string","title":"kubeconfigContext"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#kubeconfigpath","text":"\u2022 kubeconfigPath : string","title":"kubeconfigPath"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterSpec/#metrics","text":"\u2022 Optional metrics : Object","title":"metrics"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/","text":"Interface: KubernetesClusterStatus # Common . Catalog .KubernetesClusterStatus Hierarchy # CatalogEntityStatus \u21b3 KubernetesClusterStatus Table of contents # Properties # active enabled message phase reason Properties # active # \u2022 Optional active : boolean Inherited from # CatalogEntityStatus . active enabled # \u2022 Optional enabled : boolean Default true Inherited from # CatalogEntityStatus . enabled message # \u2022 Optional message : string Inherited from # CatalogEntityStatus . message phase # \u2022 phase : string Inherited from # CatalogEntityStatus . phase reason # \u2022 Optional reason : string Inherited from # CatalogEntityStatus . reason","title":"Interface: KubernetesClusterStatus"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#interface-kubernetesclusterstatus","text":"Common . Catalog .KubernetesClusterStatus","title":"Interface: KubernetesClusterStatus"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#hierarchy","text":"CatalogEntityStatus \u21b3 KubernetesClusterStatus","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#properties","text":"active enabled message phase reason","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#enabled","text":"\u2022 Optional enabled : boolean Default true","title":"enabled"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#message","text":"\u2022 Optional message : string","title":"message"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#phase","text":"\u2022 phase : string","title":"phase"},{"location":"extensions/api/interfaces/Common.Catalog.KubernetesClusterStatus/#reason","text":"\u2022 Optional reason : string","title":"reason"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/","text":"Interface: TitleCellProps # Common . Catalog .TitleCellProps These are the supported props for the title cell Table of contents # Properties # className title Properties # className # \u2022 Optional className : string title # \u2022 title : string","title":"Interface: TitleCellProps"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#interface-titlecellprops","text":"Common . Catalog .TitleCellProps These are the supported props for the title cell","title":"Interface: TitleCellProps"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#properties","text":"className title","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Common.Catalog.TitleCellProps/#title","text":"\u2022 title : string","title":"title"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/","text":"Interface: WebLinkSpec # Common . Catalog .WebLinkSpec Table of contents # Properties # url Properties # url # \u2022 url : string","title":"Interface: WebLinkSpec"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#interface-weblinkspec","text":"Common . Catalog .WebLinkSpec","title":"Interface: WebLinkSpec"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#properties","text":"url","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkSpec/#url","text":"\u2022 url : string","title":"url"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/","text":"Interface: WebLinkStatus # Common . Catalog .WebLinkStatus Hierarchy # CatalogEntityStatus \u21b3 WebLinkStatus Table of contents # Properties # active enabled message phase reason Properties # active # \u2022 Optional active : boolean Inherited from # CatalogEntityStatus . active enabled # \u2022 Optional enabled : boolean Default true Inherited from # CatalogEntityStatus . enabled message # \u2022 Optional message : string Inherited from # CatalogEntityStatus . message phase # \u2022 phase : WebLinkStatusPhase Overrides # CatalogEntityStatus . phase reason # \u2022 Optional reason : string Inherited from # CatalogEntityStatus . reason","title":"Interface: WebLinkStatus"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#interface-weblinkstatus","text":"Common . Catalog .WebLinkStatus","title":"Interface: WebLinkStatus"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#hierarchy","text":"CatalogEntityStatus \u21b3 WebLinkStatus","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#properties","text":"active enabled message phase reason","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#enabled","text":"\u2022 Optional enabled : boolean Default true","title":"enabled"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#message","text":"\u2022 Optional message : string","title":"message"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#phase","text":"\u2022 phase : WebLinkStatusPhase","title":"phase"},{"location":"extensions/api/interfaces/Common.Catalog.WebLinkStatus/#reason","text":"\u2022 Optional reason : string","title":"reason"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/","text":"Interface: AppEvent # Common . EventBus .AppEvent Data for telemetry Table of contents # Properties # action destination name params Properties # action # \u2022 action : string destination # \u2022 Optional destination : string name # \u2022 name : string params # \u2022 Optional params : Record < string , any >","title":"Interface: AppEvent"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#interface-appevent","text":"Common . EventBus .AppEvent Data for telemetry","title":"Interface: AppEvent"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#properties","text":"action destination name params","title":"Properties"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#action","text":"\u2022 action : string","title":"action"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#destination","text":"\u2022 Optional destination : string","title":"destination"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Common.EventBus.AppEvent/#params","text":"\u2022 Optional params : Record < string , any >","title":"params"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/","text":"Interface: EventEmitterOptions # Common . EventBus .EventEmitterOptions Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Table of contents # Properties # once prepend Properties # once # \u2022 Optional once : boolean prepend # \u2022 Optional prepend : boolean","title":"Interface: EventEmitterOptions"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#interface-eventemitteroptions","text":"Common . EventBus .EventEmitterOptions Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"Interface: EventEmitterOptions"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#properties","text":"once prepend","title":"Properties"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#once","text":"\u2022 Optional once : boolean","title":"once"},{"location":"extensions/api/interfaces/Common.EventBus.EventEmitterOptions/#prepend","text":"\u2022 Optional prepend : boolean","title":"prepend"},{"location":"extensions/api/interfaces/Common.InstalledExtension/","text":"Interface: InstalledExtension # Common .InstalledExtension Table of contents # Properties # absolutePath id isBundled isCompatible isEnabled manifest manifestPath Properties # absolutePath # \u2022 Readonly absolutePath : string id # \u2022 id : string isBundled # \u2022 Readonly isBundled : boolean isCompatible # \u2022 Readonly isCompatible : boolean isEnabled # \u2022 isEnabled : boolean manifest # \u2022 Readonly manifest : LensExtensionManifest manifestPath # \u2022 Readonly manifestPath : string","title":"Interface: InstalledExtension"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#interface-installedextension","text":"Common .InstalledExtension","title":"Interface: InstalledExtension"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#properties","text":"absolutePath id isBundled isCompatible isEnabled manifest manifestPath","title":"Properties"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#absolutepath","text":"\u2022 Readonly absolutePath : string","title":"absolutePath"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#id","text":"\u2022 id : string","title":"id"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#isbundled","text":"\u2022 Readonly isBundled : boolean","title":"isBundled"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#iscompatible","text":"\u2022 Readonly isCompatible : boolean","title":"isCompatible"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#isenabled","text":"\u2022 isEnabled : boolean","title":"isEnabled"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#manifest","text":"\u2022 Readonly manifest : LensExtensionManifest","title":"manifest"},{"location":"extensions/api/interfaces/Common.InstalledExtension/#manifestpath","text":"\u2022 Readonly manifestPath : string","title":"manifestPath"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/","text":"Interface: LensExtensionManifest # Common .LensExtensionManifest Hierarchy # PackageJson \u21b3 LensExtensionManifest Table of contents # Properties # engines main name renderer storeName version Properties # engines # \u2022 engines : Object Supported Lens version engine by extension could be defined in manifest.engines.lens Only MAJOR.MINOR version is taken in consideration. Type declaration # Name Type lens string node? string npm? string Overrides # PackageJson.engines main # \u2022 Optional main : string Overrides # PackageJson.main name # \u2022 name : string Overrides # PackageJson.name renderer # \u2022 Optional renderer : string storeName # \u2022 Optional storeName : string version # \u2022 version : string Overrides # PackageJson.version","title":"Interface: LensExtensionManifest"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#interface-lensextensionmanifest","text":"Common .LensExtensionManifest","title":"Interface: LensExtensionManifest"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#hierarchy","text":"PackageJson \u21b3 LensExtensionManifest","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#properties","text":"engines main name renderer storeName version","title":"Properties"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#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.","title":"engines"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#main","text":"\u2022 Optional main : string","title":"main"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#renderer","text":"\u2022 Optional renderer : string","title":"renderer"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#storename","text":"\u2022 Optional storeName : string","title":"storeName"},{"location":"extensions/api/interfaces/Common.LensExtensionManifest/#version","text":"\u2022 version : string","title":"version"},{"location":"extensions/api/interfaces/Common.Logger/","text":"Interface: Logger # Common .Logger Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Table of contents # Properties # debug error info silly warn Properties # debug # \u2022 debug : ( message : string , ... args : any ) => void Type declaration # \u25b8 ( message , ...args ): void Parameters # Name Type message string ...args any Returns # void error # \u2022 error : ( message : string , ... args : any ) => void Type declaration # \u25b8 ( message , ...args ): void Parameters # Name Type message string ...args any Returns # void info # \u2022 info : ( message : string , ... args : any ) => void Type declaration # \u25b8 ( message , ...args ): void Parameters # Name Type message string ...args any Returns # void silly # \u2022 silly : ( message : string , ... args : any ) => void Type declaration # \u25b8 ( message , ...args ): void Parameters # Name Type message string ...args any Returns # void warn # \u2022 warn : ( message : string , ... args : any ) => void Type declaration # \u25b8 ( message , ...args ): void Parameters # Name Type message string ...args any Returns # void","title":"Interface: Logger"},{"location":"extensions/api/interfaces/Common.Logger/#interface-logger","text":"Common .Logger Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"Interface: Logger"},{"location":"extensions/api/interfaces/Common.Logger/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Logger/#properties","text":"debug error info silly warn","title":"Properties"},{"location":"extensions/api/interfaces/Common.Logger/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Logger/#debug","text":"\u2022 debug : ( message : string , ... args : any ) => void","title":"debug"},{"location":"extensions/api/interfaces/Common.Logger/#error","text":"\u2022 error : ( message : string , ... args : any ) => void","title":"error"},{"location":"extensions/api/interfaces/Common.Logger/#info","text":"\u2022 info : ( message : string , ... args : any ) => void","title":"info"},{"location":"extensions/api/interfaces/Common.Logger/#silly","text":"\u2022 silly : ( message : string , ... args : any ) => void","title":"silly"},{"location":"extensions/api/interfaces/Common.Logger/#warn","text":"\u2022 warn : ( message : string , ... args : any ) => void","title":"warn"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/","text":"Interface: BaseStoreParams # Common . Store .BaseStoreParams Type parameters # Name T Hierarchy # Omit < ConfOptions < T >, \"migrations\" > \u21b3 BaseStoreParams Table of contents # Properties # configName syncOptions Properties # configName # \u2022 configName : string Overrides # Omit.configName syncOptions # \u2022 Optional syncOptions : Object Type declaration # Name Type equals? IEqualsComparer < T > fireImmediately? boolean","title":"Interface: BaseStoreParams"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#interface-basestoreparamst","text":"Common . Store .BaseStoreParams","title":"Interface: BaseStoreParams<T>"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#type-parameters","text":"Name T","title":"Type parameters"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#hierarchy","text":"Omit < ConfOptions < T >, \"migrations\" > \u21b3 BaseStoreParams","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#properties","text":"configName syncOptions","title":"Properties"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#configname","text":"\u2022 configName : string","title":"configName"},{"location":"extensions/api/interfaces/Common.Store.BaseStoreParams/#syncoptions","text":"\u2022 Optional syncOptions : Object","title":"syncOptions"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/","text":"Interface: AppPreferenceComponents # Common . Types .AppPreferenceComponents Table of contents # Properties # Hint Input Properties # Hint # \u2022 Hint : ComponentType < any > Input # \u2022 Input : ComponentType < any >","title":"Interface: AppPreferenceComponents"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#interface-apppreferencecomponents","text":"Common . Types .AppPreferenceComponents","title":"Interface: AppPreferenceComponents"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#properties","text":"Hint Input","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#hint","text":"\u2022 Hint : ComponentType < any >","title":"Hint"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceComponents/#input","text":"\u2022 Input : ComponentType < any >","title":"Input"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/","text":"Interface: AppPreferenceRegistration # Common . Types .AppPreferenceRegistration Table of contents # Properties # components id showInPreferencesTab title Properties # components # \u2022 components : AppPreferenceComponents id # \u2022 Optional id : string showInPreferencesTab # \u2022 Optional showInPreferencesTab : string title # \u2022 title : string","title":"Interface: AppPreferenceRegistration"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#interface-apppreferenceregistration","text":"Common . Types .AppPreferenceRegistration","title":"Interface: AppPreferenceRegistration"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#properties","text":"components id showInPreferencesTab title","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#components","text":"\u2022 components : AppPreferenceComponents","title":"components"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#showinpreferencestab","text":"\u2022 Optional showInPreferencesTab : string","title":"showInPreferencesTab"},{"location":"extensions/api/interfaces/Common.Types.AppPreferenceRegistration/#title","text":"\u2022 title : string","title":"title"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/","text":"Interface: ClusterPageMenuComponents # Common . Types .ClusterPageMenuComponents Table of contents # Properties # Icon Properties # Icon # \u2022 Icon : ComponentType < IconProps >","title":"Interface: ClusterPageMenuComponents"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#interface-clusterpagemenucomponents","text":"Common . Types .ClusterPageMenuComponents","title":"Interface: ClusterPageMenuComponents"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#properties","text":"Icon","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuComponents/#icon","text":"\u2022 Icon : ComponentType < IconProps >","title":"Icon"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/","text":"Interface: ClusterPageMenuRegistration # Common . Types .ClusterPageMenuRegistration Table of contents # Properties # components id orderNumber parentId target title visible Properties # components # \u2022 components : ClusterPageMenuComponents id # \u2022 Optional id : string orderNumber # \u2022 Optional orderNumber : number parentId # \u2022 Optional parentId : string target # \u2022 Optional target : PageTarget title # \u2022 title : ReactNode visible # \u2022 Optional visible : IComputedValue < boolean >","title":"Interface: ClusterPageMenuRegistration"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#interface-clusterpagemenuregistration","text":"Common . Types .ClusterPageMenuRegistration","title":"Interface: ClusterPageMenuRegistration"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#properties","text":"components id orderNumber parentId target title visible","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#components","text":"\u2022 components : ClusterPageMenuComponents","title":"components"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#ordernumber","text":"\u2022 Optional orderNumber : number","title":"orderNumber"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#parentid","text":"\u2022 Optional parentId : string","title":"parentId"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#target","text":"\u2022 Optional target : PageTarget","title":"target"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#title","text":"\u2022 title : ReactNode","title":"title"},{"location":"extensions/api/interfaces/Common.Types.ClusterPageMenuRegistration/#visible","text":"\u2022 Optional visible : IComputedValue < boolean >","title":"visible"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/","text":"Interface: CustomCategoryViewComponents # Common . Types .CustomCategoryViewComponents The components for the category view. Table of contents # Properties # View Properties # View # \u2022 View : ComponentType < CustomCategoryViewProps >","title":"Interface: CustomCategoryViewComponents"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#interface-customcategoryviewcomponents","text":"Common . Types .CustomCategoryViewComponents The components for the category view.","title":"Interface: CustomCategoryViewComponents"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#properties","text":"View","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewComponents/#view","text":"\u2022 View : ComponentType < CustomCategoryViewProps >","title":"View"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/","text":"Interface: CustomCategoryViewProps # Common . Types .CustomCategoryViewProps The props for CustomCategoryViewComponents.View Table of contents # Properties # category Properties # category # \u2022 category : CatalogCategory The category instance itself","title":"Interface: CustomCategoryViewProps"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#interface-customcategoryviewprops","text":"Common . Types .CustomCategoryViewProps The props for CustomCategoryViewComponents.View","title":"Interface: CustomCategoryViewProps"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#properties","text":"category","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewProps/#category","text":"\u2022 category : CatalogCategory The category instance itself","title":"category"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/","text":"Interface: CustomCategoryViewRegistration # Common . Types .CustomCategoryViewRegistration This is the type used to declare additional views for a specific category Table of contents # Properties # components group kind priority Properties # components # \u2022 components : CustomCategoryViewComponents The components for this registration group # \u2022 group : string The catalog entity group that is declared by the category for this registration e.g. - \"entity.k8slens.dev\" kind # \u2022 kind : string The catalog entity kind that is declared by the category for this registration e.g. - \"KubernetesCluster\" priority # \u2022 Optional priority : number The sorting order value. Used to determine the total order of the views. Default 50","title":"Interface: CustomCategoryViewRegistration"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#interface-customcategoryviewregistration","text":"Common . Types .CustomCategoryViewRegistration This is the type used to declare additional views for a specific category","title":"Interface: CustomCategoryViewRegistration"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#properties","text":"components group kind priority","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#components","text":"\u2022 components : CustomCategoryViewComponents The components for this registration","title":"components"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#group","text":"\u2022 group : string The catalog entity group that is declared by the category for this registration e.g. - \"entity.k8slens.dev\"","title":"group"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#kind","text":"\u2022 kind : string The catalog entity kind that is declared by the category for this registration e.g. - \"KubernetesCluster\"","title":"kind"},{"location":"extensions/api/interfaces/Common.Types.CustomCategoryViewRegistration/#priority","text":"\u2022 Optional priority : number The sorting order value. Used to determine the total order of the views. Default 50","title":"priority"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/","text":"Interface: KubeObjectContextMenuItem # Common . Types .KubeObjectContextMenuItem Table of contents # Properties # icon onClick title Properties # icon # \u2022 icon : string | BaseIconProps If the type is string then it is shorthand for BaseIconProps.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. onClick # \u2022 onClick : ( obj : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >) => void Type declaration # \u25b8 ( obj ): void The action when clicked Parameters # Name Type obj KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # void title # \u2022 title : string The title text for the menu item or the hover text for the icon.","title":"Interface: KubeObjectContextMenuItem"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#interface-kubeobjectcontextmenuitem","text":"Common . Types .KubeObjectContextMenuItem","title":"Interface: KubeObjectContextMenuItem"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#properties","text":"icon onClick title","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#icon","text":"\u2022 icon : string | BaseIconProps If the type is string then it is shorthand for BaseIconProps.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.","title":"icon"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#onclick","text":"\u2022 onClick : ( obj : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >) => void","title":"onClick"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectContextMenuItem/#title","text":"\u2022 title : string The title text for the menu item or the hover text for the icon.","title":"title"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/","text":"Interface: KubeObjectDetailComponents # Common . Types .KubeObjectDetailComponents Type parameters # Name Type T extends KubeObject = KubeObject Table of contents # Properties # Details Properties # Details # \u2022 Details : ComponentType < KubeObjectDetailsProps < T >>","title":"Interface: KubeObjectDetailComponents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#interface-kubeobjectdetailcomponentst","text":"Common . Types .KubeObjectDetailComponents","title":"Interface: KubeObjectDetailComponents<T>"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#type-parameters","text":"Name Type T extends KubeObject = KubeObject","title":"Type parameters"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#properties","text":"Details","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailComponents/#details","text":"\u2022 Details : ComponentType < KubeObjectDetailsProps < T >>","title":"Details"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/","text":"Interface: KubeObjectDetailRegistration # Common . Types .KubeObjectDetailRegistration Type parameters # Name Type T extends KubeObject = KubeObject Table of contents # Properties # apiVersions components kind priority visible Properties # apiVersions # \u2022 apiVersions : string [] components # \u2022 components : KubeObjectDetailComponents < T > kind # \u2022 kind : string priority # \u2022 Optional priority : number visible # \u2022 Optional visible : IComputedValue < boolean >","title":"Interface: KubeObjectDetailRegistration"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#interface-kubeobjectdetailregistrationt","text":"Common . Types .KubeObjectDetailRegistration","title":"Interface: KubeObjectDetailRegistration<T>"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#type-parameters","text":"Name Type T extends KubeObject = KubeObject","title":"Type parameters"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#properties","text":"apiVersions components kind priority visible","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#apiversions","text":"\u2022 apiVersions : string []","title":"apiVersions"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#components","text":"\u2022 components : KubeObjectDetailComponents < T >","title":"components"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#priority","text":"\u2022 Optional priority : number","title":"priority"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectDetailRegistration/#visible","text":"\u2022 Optional visible : IComputedValue < boolean >","title":"visible"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/","text":"Interface: KubeObjectHandlers # Common . Types .KubeObjectHandlers Table of contents # Properties # onContextMenuOpen Properties # onContextMenuOpen # \u2022 onContextMenuOpen : KubeObjectOnContextMenuOpen","title":"Interface: KubeObjectHandlers"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#interface-kubeobjecthandlers","text":"Common . Types .KubeObjectHandlers","title":"Interface: KubeObjectHandlers"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#properties","text":"onContextMenuOpen","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectHandlers/#oncontextmenuopen","text":"\u2022 onContextMenuOpen : KubeObjectOnContextMenuOpen","title":"onContextMenuOpen"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/","text":"Interface: KubeObjectMenuComponents # Common . Types .KubeObjectMenuComponents Table of contents # Properties # MenuItem Properties # MenuItem # \u2022 MenuItem : ComponentType < KubeObjectMenuItemProps >","title":"Interface: KubeObjectMenuComponents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#interface-kubeobjectmenucomponents","text":"Common . Types .KubeObjectMenuComponents","title":"Interface: KubeObjectMenuComponents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#properties","text":"MenuItem","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuComponents/#menuitem","text":"\u2022 MenuItem : ComponentType < KubeObjectMenuItemProps >","title":"MenuItem"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/","text":"Interface: KubeObjectMenuRegistration # Common . Types .KubeObjectMenuRegistration Table of contents # Properties # apiVersions components kind visible Properties # apiVersions # \u2022 apiVersions : string [] components # \u2022 components : KubeObjectMenuComponents kind # \u2022 kind : string visible # \u2022 Optional visible : IComputedValue < boolean >","title":"Interface: KubeObjectMenuRegistration"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#interface-kubeobjectmenuregistration","text":"Common . Types .KubeObjectMenuRegistration","title":"Interface: KubeObjectMenuRegistration"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#properties","text":"apiVersions components kind visible","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#apiversions","text":"\u2022 apiVersions : string []","title":"apiVersions"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#components","text":"\u2022 components : KubeObjectMenuComponents","title":"components"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectMenuRegistration/#visible","text":"\u2022 Optional visible : IComputedValue < boolean >","title":"visible"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/","text":"Interface: KubeObjectOnContextMenuOpenContext # Common . Types .KubeObjectOnContextMenuOpenContext Table of contents # Properties # menuItems navigate Properties # menuItems # \u2022 menuItems : KubeObjectContextMenuItem [] navigate # \u2022 navigate : ( location : string ) => void Type declaration # \u25b8 ( location ): void Parameters # Name Type location string Returns # void","title":"Interface: KubeObjectOnContextMenuOpenContext"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#interface-kubeobjectoncontextmenuopencontext","text":"Common . Types .KubeObjectOnContextMenuOpenContext","title":"Interface: KubeObjectOnContextMenuOpenContext"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#properties","text":"menuItems navigate","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#menuitems","text":"\u2022 menuItems : KubeObjectContextMenuItem []","title":"menuItems"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/#navigate","text":"\u2022 navigate : ( location : string ) => void","title":"navigate"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/","text":"Interface: KubeObjectStatusRegistration # Common . Types .KubeObjectStatusRegistration Table of contents # Properties # apiVersions kind resolve visible Properties # apiVersions # \u2022 apiVersions : string [] kind # \u2022 kind : string resolve # \u2022 resolve : ( object : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >) => KubeObjectStatus Type declaration # \u25b8 ( object ): KubeObjectStatus Parameters # Name Type object KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # KubeObjectStatus visible # \u2022 Optional visible : IComputedValue < boolean >","title":"Interface: KubeObjectStatusRegistration"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#interface-kubeobjectstatusregistration","text":"Common . Types .KubeObjectStatusRegistration","title":"Interface: KubeObjectStatusRegistration"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#properties","text":"apiVersions kind resolve visible","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#apiversions","text":"\u2022 apiVersions : string []","title":"apiVersions"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#resolve","text":"\u2022 resolve : ( object : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >) => KubeObjectStatus","title":"resolve"},{"location":"extensions/api/interfaces/Common.Types.KubeObjectStatusRegistration/#visible","text":"\u2022 Optional visible : IComputedValue < boolean >","title":"visible"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/","text":"Interface: PageComponentProps

    # Common . Types .PageComponentProps Type parameters # Name Type P extends PageParams = {} Table of contents # Properties # params Properties # params # \u2022 Optional params : { [N in string | number | symbol]: PageParam }","title":"Interface: PageComponentProps"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#interface-pagecomponentpropsp","text":"Common . Types .PageComponentProps","title":"Interface: PageComponentProps<P>"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#type-parameters","text":"Name Type P extends PageParams = {}","title":"Type parameters"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#properties","text":"params","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageComponentProps/#params","text":"\u2022 Optional params : { [N in string | number | symbol]: PageParam }","title":"params"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/","text":"Interface: PageComponents # Common . Types .PageComponents Table of contents # Properties # Page Properties # Page # \u2022 Page : ComponentType < any >","title":"Interface: PageComponents"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#interface-pagecomponents","text":"Common . Types .PageComponents","title":"Interface: PageComponents"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#properties","text":"Page","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageComponents/#page","text":"\u2022 Page : ComponentType < any >","title":"Page"},{"location":"extensions/api/interfaces/Common.Types.PageParams/","text":"Interface: PageParams # Common . Types .PageParams Type parameters # Name Type V any Indexable # \u25aa [paramName: string ]: V","title":"Interface: PageParams"},{"location":"extensions/api/interfaces/Common.Types.PageParams/#interface-pageparamsv","text":"Common . Types .PageParams","title":"Interface: PageParams<V>"},{"location":"extensions/api/interfaces/Common.Types.PageParams/#type-parameters","text":"Name Type V any","title":"Type parameters"},{"location":"extensions/api/interfaces/Common.Types.PageParams/#indexable","text":"\u25aa [paramName: string ]: V","title":"Indexable"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/","text":"Interface: PageRegistration # Common . Types .PageRegistration Table of contents # Properties # components enabled id params Properties # components # \u2022 components : PageComponents enabled # \u2022 Optional enabled : IComputedValue < boolean > id # \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 params # \u2022 Optional params : PageParams < string | Omit < PageParamInit < any >, \"name\" | \"prefix\" >>","title":"Interface: PageRegistration"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#interface-pageregistration","text":"Common . Types .PageRegistration","title":"Interface: PageRegistration"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#properties","text":"components enabled id params","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#components","text":"\u2022 components : PageComponents","title":"components"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#enabled","text":"\u2022 Optional enabled : IComputedValue < boolean >","title":"enabled"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#id","text":"\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","title":"id"},{"location":"extensions/api/interfaces/Common.Types.PageRegistration/#params","text":"\u2022 Optional params : PageParams < string | Omit < PageParamInit < any >, \"name\" | \"prefix\" >>","title":"params"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/","text":"Interface: PageTarget # Common . Types .PageTarget Table of contents # Properties # extensionId pageId params Properties # extensionId # \u2022 Optional extensionId : string pageId # \u2022 Optional pageId : string params # \u2022 Optional params : PageParams < any >","title":"Interface: PageTarget"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#interface-pagetarget","text":"Common . Types .PageTarget","title":"Interface: PageTarget"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#properties","text":"extensionId pageId params","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#extensionid","text":"\u2022 Optional extensionId : string","title":"extensionId"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#pageid","text":"\u2022 Optional pageId : string","title":"pageId"},{"location":"extensions/api/interfaces/Common.Types.PageTarget/#params","text":"\u2022 Optional params : PageParams < any >","title":"params"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/","text":"Interface: ProtocolHandlerRegistration # Common . Types .ProtocolHandlerRegistration ProtocolHandlerRegistration is the data required for an extension to register a handler to a specific path or dynamic path. Table of contents # Properties # handler pathSchema Properties # handler # \u2022 handler : ProtocolRouteHandler pathSchema # \u2022 pathSchema : string","title":"Interface: ProtocolHandlerRegistration"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#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.","title":"Interface: ProtocolHandlerRegistration"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#properties","text":"handler pathSchema","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#handler","text":"\u2022 handler : ProtocolRouteHandler","title":"handler"},{"location":"extensions/api/interfaces/Common.Types.ProtocolHandlerRegistration/#pathschema","text":"\u2022 pathSchema : string","title":"pathSchema"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/","text":"Interface: ProtocolRouteHandler # Common . Types .ProtocolRouteHandler Callable # ProtocolRouteHandler # \u25b8 ProtocolRouteHandler ( params ): void RouteHandler represents the function signature of the handler function for lens:// protocol routing. Parameters # Name Type params ProtocolRouteParams Returns # void","title":"Interface: ProtocolRouteHandler"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#interface-protocolroutehandler","text":"Common . Types .ProtocolRouteHandler","title":"Interface: ProtocolRouteHandler"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#callable","text":"","title":"Callable"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteHandler/#protocolroutehandler","text":"\u25b8 ProtocolRouteHandler ( params ): void RouteHandler represents the function signature of the handler function for lens:// protocol routing.","title":"ProtocolRouteHandler"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/","text":"Interface: ProtocolRouteParams # Common . Types .ProtocolRouteParams The collection of the dynamic parts of a URI which initiated a lens:// protocol request Table of contents # Properties # pathname search tail Properties # pathname # \u2022 pathname : Record < string , undefined | string > the matching parts of the path. The dynamic parts of the URI path. search # \u2022 search : Record < string , undefined | string > the parts of the URI query string tail # \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\" .","title":"Interface: ProtocolRouteParams"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#interface-protocolrouteparams","text":"Common . Types .ProtocolRouteParams The collection of the dynamic parts of a URI which initiated a lens:// protocol request","title":"Interface: ProtocolRouteParams"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#properties","text":"pathname search tail","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#pathname","text":"\u2022 pathname : Record < string , undefined | string > the matching parts of the path. The dynamic parts of the URI path.","title":"pathname"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#search","text":"\u2022 search : Record < string , undefined | string > the parts of the URI query string","title":"search"},{"location":"extensions/api/interfaces/Common.Types.ProtocolRouteParams/#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\" .","title":"tail"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/","text":"Interface: RegisteredPage # Common . Types .RegisteredPage Table of contents # Properties # components extensionId id params url Properties # components # \u2022 components : PageComponents extensionId # \u2022 extensionId : string id # \u2022 id : string params # \u2022 params : PageParams < PageParam < any >> url # \u2022 url : string","title":"Interface: RegisteredPage"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#interface-registeredpage","text":"Common . Types .RegisteredPage","title":"Interface: RegisteredPage"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#properties","text":"components extensionId id params url","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#components","text":"\u2022 components : PageComponents","title":"components"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#extensionid","text":"\u2022 extensionId : string","title":"extensionId"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#id","text":"\u2022 id : string","title":"id"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#params","text":"\u2022 params : PageParams < PageParam < any >>","title":"params"},{"location":"extensions/api/interfaces/Common.Types.RegisteredPage/#url","text":"\u2022 url : string","title":"url"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/","text":"Interface: ShellEnvContext # Common . Types .ShellEnvContext Table of contents # Properties # catalogEntity Properties # catalogEntity # \u2022 catalogEntity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >","title":"Interface: ShellEnvContext"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#interface-shellenvcontext","text":"Common . Types .ShellEnvContext","title":"Interface: ShellEnvContext"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#properties","text":"catalogEntity","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.ShellEnvContext/#catalogentity","text":"\u2022 catalogEntity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >","title":"catalogEntity"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/","text":"Interface: StatusBarRegistration # Common . Types .StatusBarRegistration The type for registering status bar items from the LensRendererExtension Table of contents # Properties # components item visible Properties # components # \u2022 Optional components : StatusBarComponents The newer API, allows for registering a component instead of a ReactNode item # \u2022 Optional item : ReactNode | () => ReactNode Deprecated use components instead visible # \u2022 Optional visible : IComputedValue < boolean > If specified, controls item visibility","title":"Interface: StatusBarRegistration"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#interface-statusbarregistration","text":"Common . Types .StatusBarRegistration The type for registering status bar items from the LensRendererExtension","title":"Interface: StatusBarRegistration"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#properties","text":"components item visible","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#components","text":"\u2022 Optional components : StatusBarComponents The newer API, allows for registering a component instead of a ReactNode","title":"components"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#item","text":"\u2022 Optional item : ReactNode | () => ReactNode Deprecated use components instead","title":"item"},{"location":"extensions/api/interfaces/Common.Types.StatusBarRegistration/#visible","text":"\u2022 Optional visible : IComputedValue < boolean > If specified, controls item visibility","title":"visible"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/","text":"Interface: TrayMenuRegistration # Common . Types .TrayMenuRegistration Table of contents # Properties # click enabled id label submenu toolTip type visible Properties # click # \u2022 Optional click : ( menuItem : TrayMenuRegistration ) => void Type declaration # \u25b8 ( menuItem ): void Parameters # Name Type menuItem TrayMenuRegistration Returns # void enabled # \u2022 Optional enabled : boolean | IComputedValue < boolean > id # \u2022 Optional id : string label # \u2022 Optional label : string | IComputedValue < string > submenu # \u2022 Optional submenu : TrayMenuRegistration [] toolTip # \u2022 Optional toolTip : string type # \u2022 Optional type : \"submenu\" | \"normal\" | \"separator\" visible # \u2022 Optional visible : IComputedValue < boolean >","title":"Interface: TrayMenuRegistration"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#interface-traymenuregistration","text":"Common . Types .TrayMenuRegistration","title":"Interface: TrayMenuRegistration"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#properties","text":"click enabled id label submenu toolTip type visible","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#click","text":"\u2022 Optional click : ( menuItem : TrayMenuRegistration ) => void","title":"click"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#enabled","text":"\u2022 Optional enabled : boolean | IComputedValue < boolean >","title":"enabled"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#label","text":"\u2022 Optional label : string | IComputedValue < string >","title":"label"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#submenu","text":"\u2022 Optional submenu : TrayMenuRegistration []","title":"submenu"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#tooltip","text":"\u2022 Optional toolTip : string","title":"toolTip"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#type","text":"\u2022 Optional type : \"submenu\" | \"normal\" | \"separator\"","title":"type"},{"location":"extensions/api/interfaces/Common.Types.TrayMenuRegistration/#visible","text":"\u2022 Optional visible : IComputedValue < boolean >","title":"visible"},{"location":"extensions/api/interfaces/Common.Util.Disposable/","text":"Interface: Disposable # Common . Util .Disposable Table of contents # Methods # dispose Methods # dispose # \u25b8 dispose (): void Returns # void","title":"Interface: Disposable"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#interface-disposable","text":"Common . Util .Disposable","title":"Interface: Disposable"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#methods","text":"dispose","title":"Methods"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Common.Util.Disposable/#dispose","text":"\u25b8 dispose (): void","title":"dispose"},{"location":"extensions/api/interfaces/Common.Util.Disposer/","text":"Interface: Disposer # Common . Util .Disposer Hierarchy # Disposer \u21b3 ExtendableDisposer Callable # Disposer # \u25b8 Disposer (): void Returns # void","title":"Interface: Disposer"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#interface-disposer","text":"Common . Util .Disposer","title":"Interface: Disposer"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#hierarchy","text":"Disposer \u21b3 ExtendableDisposer","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#callable","text":"","title":"Callable"},{"location":"extensions/api/interfaces/Common.Util.Disposer/#disposer","text":"\u25b8 Disposer (): void","title":"Disposer"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/","text":"Interface: ExtendableDisposer # Common . Util .ExtendableDisposer Hierarchy # Disposer \u21b3 ExtendableDisposer Callable # ExtendableDisposer # \u25b8 ExtendableDisposer (): void Returns # void Table of contents # Methods # push Methods # push # \u25b8 push ( ...vals ): void Parameters # Name Type ...vals ( Disposer | ExtendableDisposer | Disposable )[] Returns # void","title":"Interface: ExtendableDisposer"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#interface-extendabledisposer","text":"Common . Util .ExtendableDisposer","title":"Interface: ExtendableDisposer"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#hierarchy","text":"Disposer \u21b3 ExtendableDisposer","title":"Hierarchy"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#callable","text":"","title":"Callable"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#extendabledisposer","text":"\u25b8 ExtendableDisposer (): void","title":"ExtendableDisposer"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#methods","text":"push","title":"Methods"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Common.Util.ExtendableDisposer/#push","text":"\u25b8 push ( ...vals ): void","title":"push"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/","text":"Interface: CatalogEntityRegistry # Main . Catalog .CatalogEntityRegistry Table of contents # Methods # getItemsForApiKind Methods # getItemsForApiKind # \u25b8 getItemsForApiKind ( apiVersion , kind ): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >[] Parameters # Name Type apiVersion string kind string Returns # CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >[] \u25b8 getItemsForApiKind < T >( apiVersion , kind ): T [] Deprecated use a cast instead of a unbounded type parameter Type parameters # Name Type T extends CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec , T > Parameters # Name Type apiVersion string kind string Returns # T []","title":"Interface: CatalogEntityRegistry"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#interface-catalogentityregistry","text":"Main . Catalog .CatalogEntityRegistry","title":"Interface: CatalogEntityRegistry"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#methods","text":"getItemsForApiKind","title":"Methods"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Main.Catalog.CatalogEntityRegistry/#getitemsforapikind","text":"\u25b8 getItemsForApiKind ( apiVersion , kind ): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >[]","title":"getItemsForApiKind"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/","text":"Interface: BaseKubeJsonApiObjectMetadata # Main . K8sApi .BaseKubeJsonApiObjectMetadata Type parameters # Name Type Namespaced extends KubeObjectScope Indexable # \u25aa [key: string ]: unknown Table of contents # Properties # annotations clusterName creationTimestamp deletionGracePeriodSeconds deletionTimestamp finalizers generateName generation labels managedFields name namespace ownerReferences resourceVersion selfLink uid Properties # annotations # \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 clusterName # \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 apiserver is going to ignore it if set in create or update request. creationTimestamp # \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 deletionGracePeriodSeconds # \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. deletionTimestamp # \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 finalizers # \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. generateName # \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 generation # \u2022 Optional Readonly generation : number A sequence number representing a specific generation of the desired state. Populated by the system. labels # \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 managedFields # \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. name # \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 namespace # \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 ownerReferences # \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. resourceVersion # \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 selfLink # \u2022 Optional Readonly selfLink : string SelfLink is a URL representing this object. Populated by the system. uid # \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","title":"Interface: BaseKubeJsonApiObjectMetadata"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#interface-basekubejsonapiobjectmetadatanamespaced","text":"Main . K8sApi .BaseKubeJsonApiObjectMetadata","title":"Interface: BaseKubeJsonApiObjectMetadata<Namespaced>"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#type-parameters","text":"Name Type Namespaced extends KubeObjectScope","title":"Type parameters"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#indexable","text":"\u25aa [key: string ]: unknown","title":"Indexable"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#properties","text":"annotations clusterName creationTimestamp deletionGracePeriodSeconds deletionTimestamp finalizers generateName generation labels managedFields name namespace ownerReferences resourceVersion selfLink uid","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#annotations","text":"\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","title":"annotations"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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 apiserver is going to ignore it if set in create or update request.","title":"clusterName"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"creationTimestamp"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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.","title":"deletionGracePeriodSeconds"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"deletionTimestamp"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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.","title":"finalizers"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"generateName"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#generation","text":"\u2022 Optional Readonly generation : number A sequence number representing a specific generation of the desired state. Populated by the system.","title":"generation"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"labels"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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.","title":"managedFields"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"name"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"namespace"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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.","title":"ownerReferences"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"resourceVersion"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#selflink","text":"\u2022 Optional Readonly selfLink : string SelfLink is a URL representing this object. Populated by the system.","title":"selfLink"},{"location":"extensions/api/interfaces/Main.K8sApi.BaseKubeJsonApiObjectMetadata/#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","title":"uid"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/","text":"Interface: IKubeApiCluster # Main . K8sApi .IKubeApiCluster Deprecated This type is unused Table of contents # Properties # metadata Properties # metadata # \u2022 metadata : Object Type declaration # Name Type uid string","title":"Interface: IKubeApiCluster"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#interface-ikubeapicluster","text":"Main . K8sApi .IKubeApiCluster Deprecated This type is unused","title":"Interface: IKubeApiCluster"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#properties","text":"metadata","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IKubeApiCluster/#metadata","text":"\u2022 metadata : Object","title":"metadata"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/","text":"Interface: ILocalKubeApiConfig # Main . K8sApi .ILocalKubeApiConfig Table of contents # Properties # metadata Properties # metadata # \u2022 metadata : Object Type declaration # Name Type uid string","title":"Interface: ILocalKubeApiConfig"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#interface-ilocalkubeapiconfig","text":"Main . K8sApi .ILocalKubeApiConfig","title":"Interface: ILocalKubeApiConfig"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#properties","text":"metadata","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.ILocalKubeApiConfig/#metadata","text":"\u2022 metadata : Object","title":"metadata"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/","text":"Interface: IPodContainer # Main . K8sApi .IPodContainer A single application container that you want to run within a pod. Table of contents # Properties # args command env envFrom image imagePullPolicy lifecycle livenessProbe name ports readinessProbe resources securityContext startupProbe stdin stdinOnce terminationMessagePath terminationMessagePolicy tty volumeDevices volumeMounts workingDir Properties # args # \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 command # \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 env # \u2022 Optional env : EnvVar [] List of environment variables to set in the container. Cannot be updated. envFrom # \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. image # \u2022 Optional image : string Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images imagePullPolicy # \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 lifecycle # \u2022 Optional lifecycle : Lifecycle livenessProbe # \u2022 Optional livenessProbe : Probe name # \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. ports # \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. readinessProbe # \u2022 Optional readinessProbe : Probe resources # \u2022 Optional resources : ResourceRequirements securityContext # \u2022 Optional securityContext : SecurityContext startupProbe # \u2022 Optional startupProbe : Probe stdin # \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 stdinOnce # \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 terminationMessagePath # \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\" terminationMessagePolicy # \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\" tty # \u2022 Optional tty : boolean Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default false volumeDevices # \u2022 Optional volumeDevices : VolumeDevice [] volumeDevices is the list of block devices to be used by the container. volumeMounts # \u2022 Optional volumeMounts : VolumeMount [] Pod volumes to mount into the container's filesystem. Cannot be updated. workingDir # \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.","title":"Interface: IPodContainer"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#interface-ipodcontainer","text":"Main . K8sApi .IPodContainer A single application container that you want to run within a pod.","title":"Interface: IPodContainer"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#properties","text":"args command env envFrom image imagePullPolicy lifecycle livenessProbe name ports readinessProbe resources securityContext startupProbe stdin stdinOnce terminationMessagePath terminationMessagePolicy tty volumeDevices volumeMounts workingDir","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#args","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","title":"args"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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","title":"command"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#env","text":"\u2022 Optional env : EnvVar [] List of environment variables to set in the container. Cannot be updated.","title":"env"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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.","title":"envFrom"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#image","text":"\u2022 Optional image : string Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images","title":"image"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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","title":"imagePullPolicy"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#lifecycle","text":"\u2022 Optional lifecycle : Lifecycle","title":"lifecycle"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#livenessprobe","text":"\u2022 Optional livenessProbe : Probe","title":"livenessProbe"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#name","text":"\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.","title":"name"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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.","title":"ports"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#readinessprobe","text":"\u2022 Optional readinessProbe : Probe","title":"readinessProbe"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#resources","text":"\u2022 Optional resources : ResourceRequirements","title":"resources"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#securitycontext","text":"\u2022 Optional securityContext : SecurityContext","title":"securityContext"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#startupprobe","text":"\u2022 Optional startupProbe : Probe","title":"startupProbe"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#stdin","text":"\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","title":"stdin"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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","title":"stdinOnce"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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\"","title":"terminationMessagePath"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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\"","title":"terminationMessagePolicy"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#tty","text":"\u2022 Optional tty : boolean Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default false","title":"tty"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#volumedevices","text":"\u2022 Optional volumeDevices : VolumeDevice [] volumeDevices is the list of block devices to be used by the container.","title":"volumeDevices"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#volumemounts","text":"\u2022 Optional volumeMounts : VolumeMount [] Pod volumes to mount into the container's filesystem. Cannot be updated.","title":"volumeMounts"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainer/#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.","title":"workingDir"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/","text":"Interface: IPodContainerStatus # Main . K8sApi .IPodContainerStatus Table of contents # Properties # containerID image imageID lastState name ready restartCount started state Properties # containerID # \u2022 Optional containerID : string image # \u2022 image : string imageID # \u2022 imageID : string lastState # \u2022 Optional lastState : ContainerState name # \u2022 name : string ready # \u2022 ready : boolean restartCount # \u2022 restartCount : number started # \u2022 Optional started : boolean state # \u2022 Optional state : ContainerState","title":"Interface: IPodContainerStatus"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#interface-ipodcontainerstatus","text":"Main . K8sApi .IPodContainerStatus","title":"Interface: IPodContainerStatus"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#properties","text":"containerID image imageID lastState name ready restartCount started state","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#containerid","text":"\u2022 Optional containerID : string","title":"containerID"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#image","text":"\u2022 image : string","title":"image"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#imageid","text":"\u2022 imageID : string","title":"imageID"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#laststate","text":"\u2022 Optional lastState : ContainerState","title":"lastState"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#ready","text":"\u2022 ready : boolean","title":"ready"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#restartcount","text":"\u2022 restartCount : number","title":"restartCount"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#started","text":"\u2022 Optional started : boolean","title":"started"},{"location":"extensions/api/interfaces/Main.K8sApi.IPodContainerStatus/#state","text":"\u2022 Optional state : ContainerState","title":"state"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/","text":"Interface: IRemoteKubeApiConfig # Main . K8sApi .IRemoteKubeApiConfig Table of contents # Properties # agent cluster user Properties # agent # \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. cluster # \u2022 cluster : Object Type declaration # Name Type caData? string server string skipTLSVerify? boolean user # \u2022 user : Object Type declaration # Name Type clientCertificateData? string clientKeyData? string token? string | () => Promise < string >","title":"Interface: IRemoteKubeApiConfig"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#interface-iremotekubeapiconfig","text":"Main . K8sApi .IRemoteKubeApiConfig","title":"Interface: IRemoteKubeApiConfig"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#properties","text":"agent cluster user","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#agent","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.","title":"agent"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#cluster","text":"\u2022 cluster : Object","title":"cluster"},{"location":"extensions/api/interfaces/Main.K8sApi.IRemoteKubeApiConfig/#user","text":"\u2022 user : Object","title":"user"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/","text":"Interface: ISecretRef # Main . K8sApi .ISecretRef Table of contents # Properties # name namespace Properties # name # \u2022 name : string namespace # \u2022 Optional namespace : string","title":"Interface: ISecretRef"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#interface-isecretref","text":"Main . K8sApi .ISecretRef","title":"Interface: ISecretRef"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#properties","text":"name namespace","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Main.K8sApi.ISecretRef/#namespace","text":"\u2022 Optional namespace : string","title":"namespace"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/","text":"Interface: IgnoredKubeApiOptions # Main . K8sApi .IgnoredKubeApiOptions Deprecated This type is only present for backwards compatable typescript support Table of contents # Properties # apiBase isNamespaces kind objectConstructor Properties # apiBase # \u2022 Optional apiBase : any Deprecated this option is overridden and should not be used isNamespaces # \u2022 Optional isNamespaces : any Deprecated this option is overridden and should not be used kind # \u2022 Optional kind : any Deprecated this option is overridden and should not be used objectConstructor # \u2022 Optional objectConstructor : any Deprecated this option is overridden and should not be used","title":"Interface: IgnoredKubeApiOptions"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#interface-ignoredkubeapioptions","text":"Main . K8sApi .IgnoredKubeApiOptions Deprecated This type is only present for backwards compatable typescript support","title":"Interface: IgnoredKubeApiOptions"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#properties","text":"apiBase isNamespaces kind objectConstructor","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#apibase","text":"\u2022 Optional apiBase : any Deprecated this option is overridden and should not be used","title":"apiBase"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#isnamespaces","text":"\u2022 Optional isNamespaces : any Deprecated this option is overridden and should not be used","title":"isNamespaces"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#kind","text":"\u2022 Optional kind : any Deprecated this option is overridden and should not be used","title":"kind"},{"location":"extensions/api/interfaces/Main.K8sApi.IgnoredKubeApiOptions/#objectconstructor","text":"\u2022 Optional objectConstructor : any Deprecated this option is overridden and should not be used","title":"objectConstructor"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/","text":"Interface: KubeJsonApiData # Main . K8sApi .KubeJsonApiData Type parameters # Name Type Metadata extends KubeJsonApiObjectMetadata = KubeJsonApiObjectMetadata Status unknown Spec unknown Hierarchy # JsonApiData \u21b3 KubeJsonApiData Indexable # \u25aa [otherKeys: string ]: unknown Table of contents # Properties # apiVersion kind metadata spec status Properties # apiVersion # \u2022 apiVersion : string kind # \u2022 kind : string metadata # \u2022 metadata : Metadata spec # \u2022 Optional spec : Spec status # \u2022 Optional status : Status","title":"Interface: KubeJsonApiData"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#interface-kubejsonapidatametadata-status-spec","text":"Main . K8sApi .KubeJsonApiData","title":"Interface: KubeJsonApiData<Metadata, Status, Spec>"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#type-parameters","text":"Name Type Metadata extends KubeJsonApiObjectMetadata = KubeJsonApiObjectMetadata Status unknown Spec unknown","title":"Type parameters"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#hierarchy","text":"JsonApiData \u21b3 KubeJsonApiData","title":"Hierarchy"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#indexable","text":"\u25aa [otherKeys: string ]: unknown","title":"Indexable"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#properties","text":"apiVersion kind metadata spec status","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#spec","text":"\u2022 Optional spec : Spec","title":"spec"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeJsonApiData/#status","text":"\u2022 Optional status : Status","title":"status"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/","text":"Interface: KubeObjectStoreLoadAllParams # Main . K8sApi .KubeObjectStoreLoadAllParams Table of contents # Properties # merge namespaces onLoadFailure reqInit Properties # merge # \u2022 Optional merge : boolean namespaces # \u2022 Optional namespaces : string [] onLoadFailure # \u2022 Optional onLoadFailure : OnLoadFailure A function that is called when listing fails. If set then blocks errors being rejected with reqInit # \u2022 Optional reqInit : RequestInit","title":"Interface: KubeObjectStoreLoadAllParams"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#interface-kubeobjectstoreloadallparams","text":"Main . K8sApi .KubeObjectStoreLoadAllParams","title":"Interface: KubeObjectStoreLoadAllParams"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#properties","text":"merge namespaces onLoadFailure reqInit","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#merge","text":"\u2022 Optional merge : boolean","title":"merge"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#namespaces","text":"\u2022 Optional namespaces : string []","title":"namespaces"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#onloadfailure","text":"\u2022 Optional onLoadFailure : OnLoadFailure A function that is called when listing fails. If set then blocks errors being rejected with","title":"onLoadFailure"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadAllParams/#reqinit","text":"\u2022 Optional reqInit : RequestInit","title":"reqInit"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/","text":"Interface: KubeObjectStoreLoadingParams # Main . K8sApi .KubeObjectStoreLoadingParams Table of contents # Properties # namespaces onLoadFailure reqInit Properties # namespaces # \u2022 namespaces : string [] onLoadFailure # \u2022 Optional onLoadFailure : OnLoadFailure A function that is called when listing fails. If set then blocks errors being rejected with reqInit # \u2022 Optional reqInit : RequestInit","title":"Interface: KubeObjectStoreLoadingParams"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#interface-kubeobjectstoreloadingparams","text":"Main . K8sApi .KubeObjectStoreLoadingParams","title":"Interface: KubeObjectStoreLoadingParams"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#properties","text":"namespaces onLoadFailure reqInit","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#namespaces","text":"\u2022 namespaces : string []","title":"namespaces"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#onloadfailure","text":"\u2022 Optional onLoadFailure : OnLoadFailure A function that is called when listing fails. If set then blocks errors being rejected with","title":"onLoadFailure"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreLoadingParams/#reqinit","text":"\u2022 Optional reqInit : RequestInit","title":"reqInit"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/","text":"Interface: KubeObjectStoreSubscribeParams # Main . K8sApi .KubeObjectStoreSubscribeParams Table of contents # Properties # abortController onLoadFailure Properties # abortController # \u2022 Optional abortController : AbortController An optional parent abort controller onLoadFailure # \u2022 Optional onLoadFailure : OnLoadFailure A function that is called when listing fails. If set then blocks errors being rejected with","title":"Interface: KubeObjectStoreSubscribeParams"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#interface-kubeobjectstoresubscribeparams","text":"Main . K8sApi .KubeObjectStoreSubscribeParams","title":"Interface: KubeObjectStoreSubscribeParams"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#properties","text":"abortController onLoadFailure","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#abortcontroller","text":"\u2022 Optional abortController : AbortController An optional parent abort controller","title":"abortController"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeObjectStoreSubscribeParams/#onloadfailure","text":"\u2022 Optional onLoadFailure : OnLoadFailure A function that is called when listing fails. If set then blocks errors being rejected with","title":"onLoadFailure"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/","text":"Interface: KubeStatusData # Main . K8sApi .KubeStatusData Table of contents # Properties # apiVersion code kind message reason Properties # apiVersion # \u2022 apiVersion : string code # \u2022 code : number kind # \u2022 kind : string message # \u2022 Optional message : string reason # \u2022 Optional reason : string","title":"Interface: KubeStatusData"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#interface-kubestatusdata","text":"Main . K8sApi .KubeStatusData","title":"Interface: KubeStatusData"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#properties","text":"apiVersion code kind message reason","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#code","text":"\u2022 code : number","title":"code"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#message","text":"\u2022 Optional message : string","title":"message"},{"location":"extensions/api/interfaces/Main.K8sApi.KubeStatusData/#reason","text":"\u2022 Optional reason : string","title":"reason"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/","text":"Interface: OwnerReference # Main . K8sApi .OwnerReference Table of contents # Properties # apiVersion blockOwnerDeletion controller kind name uid Properties # apiVersion # \u2022 apiVersion : string blockOwnerDeletion # \u2022 Optional blockOwnerDeletion : boolean controller # \u2022 Optional controller : boolean kind # \u2022 kind : string name # \u2022 name : string uid # \u2022 uid : string","title":"Interface: OwnerReference"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#interface-ownerreference","text":"Main . K8sApi .OwnerReference","title":"Interface: OwnerReference"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#properties","text":"apiVersion blockOwnerDeletion controller kind name uid","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#blockownerdeletion","text":"\u2022 Optional blockOwnerDeletion : boolean","title":"blockOwnerDeletion"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#controller","text":"\u2022 Optional controller : boolean","title":"controller"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Main.K8sApi.OwnerReference/#uid","text":"\u2022 uid : string","title":"uid"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/","text":"Interface: AdditionalCategoryColumnRegistration # Renderer . Component .AdditionalCategoryColumnRegistration This is the type used to declare new catalog category columns Hierarchy # CategoryColumnRegistration \u21b3 AdditionalCategoryColumnRegistration Table of contents # Properties # group id kind priority renderCell searchFilter sortCallback titleProps Properties # group # \u2022 group : string The catalog entity group that is declared by the category for this registration e.g. - \"entity.k8slens.dev\" id # \u2022 id : string This value MUST to be unique to your extension Inherited from # CategoryColumnRegistration . id kind # \u2022 kind : string The catalog entity kind that is declared by the category for this registration e.g. - \"KubernetesCluster\" priority # \u2022 Optional priority : number The sorting order value. Default 50 Inherited from # CategoryColumnRegistration . priority renderCell # \u2022 renderCell : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => ReactNode Type declaration # \u25b8 ( entity ): ReactNode This function will be called to generate the cells (on demand) for the column Parameters # Name Type entity CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Returns # ReactNode Inherited from # CategoryColumnRegistration . renderCell searchFilter # \u2022 Optional searchFilter : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | string [] Type declaration # \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. Parameters # Name Type entity CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Returns # string | string [] Inherited from # CategoryColumnRegistration . searchFilter sortCallback # \u2022 Optional sortCallback : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | number | ( string | number )[] Type declaration # \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. Parameters # Name Type entity CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Returns # string | number | ( string | number )[] Inherited from # CategoryColumnRegistration . sortCallback titleProps # \u2022 titleProps : TitleCellProps This function will be used to generate the columns title cell. Inherited from # CategoryColumnRegistration . titleProps","title":"Interface: AdditionalCategoryColumnRegistration"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#interface-additionalcategorycolumnregistration","text":"Renderer . Component .AdditionalCategoryColumnRegistration This is the type used to declare new catalog category columns","title":"Interface: AdditionalCategoryColumnRegistration"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#hierarchy","text":"CategoryColumnRegistration \u21b3 AdditionalCategoryColumnRegistration","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#properties","text":"group id kind priority renderCell searchFilter sortCallback titleProps","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#group","text":"\u2022 group : string The catalog entity group that is declared by the category for this registration e.g. - \"entity.k8slens.dev\"","title":"group"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#id","text":"\u2022 id : string This value MUST to be unique to your extension","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#kind","text":"\u2022 kind : string The catalog entity kind that is declared by the category for this registration e.g. - \"KubernetesCluster\"","title":"kind"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#priority","text":"\u2022 Optional priority : number The sorting order value. Default 50","title":"priority"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#rendercell","text":"\u2022 renderCell : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => ReactNode","title":"renderCell"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#searchfilter","text":"\u2022 Optional searchFilter : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | string []","title":"searchFilter"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#sortcallback","text":"\u2022 Optional sortCallback : ( entity : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >) => string | number | ( string | number )[]","title":"sortCallback"},{"location":"extensions/api/interfaces/Renderer.Component.AdditionalCategoryColumnRegistration/#titleprops","text":"\u2022 titleProps : TitleCellProps This function will be used to generate the columns title cell.","title":"titleProps"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/","text":"Interface: BadgeProps # Renderer . Component .BadgeProps Hierarchy # HTMLAttributes < HTMLDivElement > \u21b3 BadgeProps Table of contents # Properties # disabled expandable flat label scrollable small Properties # disabled # \u2022 Optional disabled : boolean expandable # \u2022 Optional expandable : boolean flat # \u2022 Optional flat : boolean label # \u2022 Optional label : ReactNode scrollable # \u2022 Optional scrollable : boolean small # \u2022 Optional small : boolean","title":"Interface: BadgeProps"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#interface-badgeprops","text":"Renderer . Component .BadgeProps","title":"Interface: BadgeProps"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#hierarchy","text":"HTMLAttributes < HTMLDivElement > \u21b3 BadgeProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#properties","text":"disabled expandable flat label scrollable small","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#expandable","text":"\u2022 Optional expandable : boolean","title":"expandable"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#flat","text":"\u2022 Optional flat : boolean","title":"flat"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#label","text":"\u2022 Optional label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#scrollable","text":"\u2022 Optional scrollable : boolean","title":"scrollable"},{"location":"extensions/api/interfaces/Renderer.Component.BadgeProps/#small","text":"\u2022 Optional small : boolean","title":"small"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/","text":"Interface: BarChartProps # Renderer . Component .BarChartProps Hierarchy # ChartProps \u21b3 BarChartProps Table of contents # Properties # className data data-testid height legendColors legendPosition name options plugins redraw showChart showLegend timeLabelStep title type width Properties # className # \u2022 Optional className : string Inherited from # ChartProps.className data # \u2022 data : ChartData Inherited from # ChartProps.data data-testid # \u2022 Optional data-testid : string Inherited from # ChartProps.data-testid height # \u2022 Optional height : string | number Inherited from # ChartProps.height legendColors # \u2022 Optional legendColors : string [] Inherited from # ChartProps.legendColors legendPosition # \u2022 Optional legendPosition : \"bottom\" Inherited from # ChartProps.legendPosition name # \u2022 Optional name : string options # \u2022 Optional options : ChartOptions Inherited from # ChartProps.options plugins # \u2022 Optional plugins : PluginServiceRegistrationOptions [] Inherited from # ChartProps.plugins redraw # \u2022 Optional redraw : boolean Inherited from # ChartProps.redraw showChart # \u2022 Optional showChart : boolean Inherited from # ChartProps.showChart showLegend # \u2022 Optional showLegend : boolean Inherited from # ChartProps.showLegend timeLabelStep # \u2022 Optional timeLabelStep : number title # \u2022 Optional title : string Inherited from # ChartProps.title type # \u2022 Optional type : ChartKind Inherited from # ChartProps.type width # \u2022 Optional width : string | number Inherited from # ChartProps.width","title":"Interface: BarChartProps"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#interface-barchartprops","text":"Renderer . Component .BarChartProps","title":"Interface: BarChartProps"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#hierarchy","text":"ChartProps \u21b3 BarChartProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#properties","text":"className data data-testid height legendColors legendPosition name options plugins redraw showChart showLegend timeLabelStep title type width","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#data","text":"\u2022 data : ChartData","title":"data"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#height","text":"\u2022 Optional height : string | number","title":"height"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#legendcolors","text":"\u2022 Optional legendColors : string []","title":"legendColors"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#legendposition","text":"\u2022 Optional legendPosition : \"bottom\"","title":"legendPosition"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#name","text":"\u2022 Optional name : string","title":"name"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#options","text":"\u2022 Optional options : ChartOptions","title":"options"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#plugins","text":"\u2022 Optional plugins : PluginServiceRegistrationOptions []","title":"plugins"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#redraw","text":"\u2022 Optional redraw : boolean","title":"redraw"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#showchart","text":"\u2022 Optional showChart : boolean","title":"showChart"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#showlegend","text":"\u2022 Optional showLegend : boolean","title":"showLegend"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#timelabelstep","text":"\u2022 Optional timeLabelStep : number","title":"timeLabelStep"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#type","text":"\u2022 Optional type : ChartKind","title":"type"},{"location":"extensions/api/interfaces/Renderer.Component.BarChartProps/#width","text":"\u2022 Optional width : string | number","title":"width"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/","text":"Interface: BaseIconProps # Renderer . Component .BaseIconProps Hierarchy # BaseIconProps \u21b3 IconProps Table of contents # Properties # active big data-testid disabled focusable href interactive link material size small smallest sticker svg Properties # active # \u2022 Optional active : boolean apply active-state styles big # \u2022 Optional big : boolean A pre-defined icon-size data-testid # \u2022 Optional data-testid : string disabled # \u2022 Optional disabled : boolean focusable # \u2022 Optional focusable : boolean Allow focus to the icon to show .active styles. Only applicable if interactive is true . Default true href # \u2022 Optional href : string render icon as hyperlink interactive # \u2022 Optional interactive : boolean indicates that icon is interactive and highlight it on focus/hover link # \u2022 Optional link : LocationDescriptor < unknown > render icon as NavLink from react-router-dom material # \u2022 Optional material : string One of the names from https://material.io/icons/ size # \u2022 Optional size : string | number The icon size (css units) small # \u2022 Optional small : boolean A pre-defined icon-size smallest # \u2022 Optional smallest : boolean A pre-defined icon-size sticker # \u2022 Optional sticker : boolean svg # \u2022 Optional svg : string Either an SVG XML or one of the following names - 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","title":"Interface: BaseIconProps"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#interface-baseiconprops","text":"Renderer . Component .BaseIconProps","title":"Interface: BaseIconProps"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#hierarchy","text":"BaseIconProps \u21b3 IconProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#properties","text":"active big data-testid disabled focusable href interactive link material size small smallest sticker svg","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#active","text":"\u2022 Optional active : boolean apply active-state styles","title":"active"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#big","text":"\u2022 Optional big : boolean A pre-defined icon-size","title":"big"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#focusable","text":"\u2022 Optional focusable : boolean Allow focus to the icon to show .active styles. Only applicable if interactive is true . Default true","title":"focusable"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#href","text":"\u2022 Optional href : string render icon as hyperlink","title":"href"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#interactive","text":"\u2022 Optional interactive : boolean indicates that icon is interactive and highlight it on focus/hover","title":"interactive"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#link","text":"\u2022 Optional link : LocationDescriptor < unknown > render icon as NavLink from react-router-dom","title":"link"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#material","text":"\u2022 Optional material : string One of the names from https://material.io/icons/","title":"material"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#size","text":"\u2022 Optional size : string | number The icon size (css units)","title":"size"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#small","text":"\u2022 Optional small : boolean A pre-defined icon-size","title":"small"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#smallest","text":"\u2022 Optional smallest : boolean A pre-defined icon-size","title":"smallest"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#sticker","text":"\u2022 Optional sticker : boolean","title":"sticker"},{"location":"extensions/api/interfaces/Renderer.Component.BaseIconProps/#svg","text":"\u2022 Optional svg : string Either an SVG XML or one of the following names - 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","title":"svg"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/","text":"Interface: ButtonProps # Renderer . Component .ButtonProps Hierarchy # ButtonHTMLAttributes < any > \u21b3 ButtonProps Table of contents # Properties # accent active big hidden href label light outlined plain primary round target waiting Properties # accent # \u2022 Optional accent : boolean active # \u2022 Optional active : boolean big # \u2022 Optional big : boolean hidden # \u2022 Optional hidden : boolean Overrides # ButtonHTMLAttributes.hidden href # \u2022 Optional href : string label # \u2022 Optional label : ReactNode light # \u2022 Optional light : boolean outlined # \u2022 Optional outlined : boolean plain # \u2022 Optional plain : boolean primary # \u2022 Optional primary : boolean round # \u2022 Optional round : boolean target # \u2022 Optional target : \"_blank\" waiting # \u2022 Optional waiting : boolean","title":"Interface: ButtonProps"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#interface-buttonprops","text":"Renderer . Component .ButtonProps","title":"Interface: ButtonProps"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#hierarchy","text":"ButtonHTMLAttributes < any > \u21b3 ButtonProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#properties","text":"accent active big hidden href label light outlined plain primary round target waiting","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#accent","text":"\u2022 Optional accent : boolean","title":"accent"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#big","text":"\u2022 Optional big : boolean","title":"big"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#href","text":"\u2022 Optional href : string","title":"href"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#label","text":"\u2022 Optional label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#light","text":"\u2022 Optional light : boolean","title":"light"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#outlined","text":"\u2022 Optional outlined : boolean","title":"outlined"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#plain","text":"\u2022 Optional plain : boolean","title":"plain"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#primary","text":"\u2022 Optional primary : boolean","title":"primary"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#round","text":"\u2022 Optional round : boolean","title":"round"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#target","text":"\u2022 Optional target : \"_blank\"","title":"target"},{"location":"extensions/api/interfaces/Renderer.Component.ButtonProps/#waiting","text":"\u2022 Optional waiting : boolean","title":"waiting"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/","text":"Interface: CheckboxProps # Renderer . Component .CheckboxProps Table of contents # Properties # children className disabled inline label value Methods # onChange Properties # children # \u2022 Optional children : SingleOrMany < ReactChild | ReactFragment > className # \u2022 Optional className : string disabled # \u2022 Optional disabled : boolean inline # \u2022 Optional inline : boolean label # \u2022 Optional label : ReactNode value # \u2022 Optional value : boolean Methods # onChange # \u25b8 Optional onChange ( value , evt ): void Parameters # Name Type value boolean evt ChangeEvent < HTMLInputElement > Returns # void","title":"Interface: CheckboxProps"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#interface-checkboxprops","text":"Renderer . Component .CheckboxProps","title":"Interface: CheckboxProps"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#properties","text":"children className disabled inline label value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#methods","text":"onChange","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#children","text":"\u2022 Optional children : SingleOrMany < ReactChild | ReactFragment >","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#inline","text":"\u2022 Optional inline : boolean","title":"inline"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#label","text":"\u2022 Optional label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#value","text":"\u2022 Optional value : boolean","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.CheckboxProps/#onchange","text":"\u25b8 Optional onChange ( value , evt ): void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/","text":"Interface: ConfirmDialogBooleanParams # Renderer . Component .ConfirmDialogBooleanParams Hierarchy # ConfirmDialogBooleanParams \u21b3 ConfirmDialogParams Table of contents # Properties # cancelButtonProps icon labelCancel labelOk message okButtonProps Properties # cancelButtonProps # \u2022 Optional cancelButtonProps : Partial < ButtonProps > icon # \u2022 Optional icon : ReactNode labelCancel # \u2022 Optional labelCancel : ReactNode labelOk # \u2022 Optional labelOk : ReactNode message # \u2022 message : ReactNode okButtonProps # \u2022 Optional okButtonProps : Partial < ButtonProps >","title":"Interface: ConfirmDialogBooleanParams"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#interface-confirmdialogbooleanparams","text":"Renderer . Component .ConfirmDialogBooleanParams","title":"Interface: ConfirmDialogBooleanParams"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#hierarchy","text":"ConfirmDialogBooleanParams \u21b3 ConfirmDialogParams","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#properties","text":"cancelButtonProps icon labelCancel labelOk message okButtonProps","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#cancelbuttonprops","text":"\u2022 Optional cancelButtonProps : Partial < ButtonProps >","title":"cancelButtonProps"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#icon","text":"\u2022 Optional icon : ReactNode","title":"icon"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#labelcancel","text":"\u2022 Optional labelCancel : ReactNode","title":"labelCancel"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#labelok","text":"\u2022 Optional labelOk : ReactNode","title":"labelOk"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#message","text":"\u2022 message : ReactNode","title":"message"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogBooleanParams/#okbuttonprops","text":"\u2022 Optional okButtonProps : Partial < ButtonProps >","title":"okButtonProps"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/","text":"Interface: ConfirmDialogParams # Renderer . Component .ConfirmDialogParams Hierarchy # ConfirmDialogBooleanParams \u21b3 ConfirmDialogParams Table of contents # Properties # cancel cancelButtonProps icon labelCancel labelOk message ok okButtonProps Properties # cancel # \u2022 Optional cancel : () => any Type declaration # \u25b8 (): any Returns # any cancelButtonProps # \u2022 Optional cancelButtonProps : Partial < ButtonProps > Inherited from # ConfirmDialogBooleanParams . cancelButtonProps icon # \u2022 Optional icon : ReactNode Inherited from # ConfirmDialogBooleanParams . icon labelCancel # \u2022 Optional labelCancel : ReactNode Inherited from # ConfirmDialogBooleanParams . labelCancel labelOk # \u2022 Optional labelOk : ReactNode Inherited from # ConfirmDialogBooleanParams . labelOk message # \u2022 message : ReactNode Inherited from # ConfirmDialogBooleanParams . message ok # \u2022 Optional ok : () => any Type declaration # \u25b8 (): any Returns # any okButtonProps # \u2022 Optional okButtonProps : Partial < ButtonProps > Inherited from # ConfirmDialogBooleanParams . okButtonProps","title":"Interface: ConfirmDialogParams"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#interface-confirmdialogparams","text":"Renderer . Component .ConfirmDialogParams","title":"Interface: ConfirmDialogParams"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#hierarchy","text":"ConfirmDialogBooleanParams \u21b3 ConfirmDialogParams","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#properties","text":"cancel cancelButtonProps icon labelCancel labelOk message ok okButtonProps","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#cancel","text":"\u2022 Optional cancel : () => any","title":"cancel"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#cancelbuttonprops","text":"\u2022 Optional cancelButtonProps : Partial < ButtonProps >","title":"cancelButtonProps"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#icon","text":"\u2022 Optional icon : ReactNode","title":"icon"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#labelcancel","text":"\u2022 Optional labelCancel : ReactNode","title":"labelCancel"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#labelok","text":"\u2022 Optional labelOk : ReactNode","title":"labelOk"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#message","text":"\u2022 message : ReactNode","title":"message"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#ok","text":"\u2022 Optional ok : () => any","title":"ok"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/#okbuttonprops","text":"\u2022 Optional okButtonProps : Partial < ButtonProps >","title":"okButtonProps"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/","text":"Interface: ConfirmDialogProps # Renderer . Component .ConfirmDialogProps Hierarchy # Partial < DialogProps > \u21b3 ConfirmDialogProps Table of contents # Properties # animated children className close data-testid isOpen modal onClose onOpen open pinned Properties # animated # \u2022 Optional animated : boolean Inherited from # Partial.animated children # \u2022 Optional children : ReactNode | ReactNode [] Inherited from # Partial.children className # \u2022 Optional className : string Inherited from # Partial.className close # \u2022 Optional close : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # Partial.close data-testid # \u2022 Optional data-testid : string Inherited from # Partial.data-testid isOpen # \u2022 Optional isOpen : boolean Inherited from # Partial.isOpen modal # \u2022 Optional modal : boolean Inherited from # Partial.modal onClose # \u2022 Optional onClose : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # Partial.onClose onOpen # \u2022 Optional onOpen : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # Partial.onOpen open # \u2022 Optional open : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # Partial.open pinned # \u2022 Optional pinned : boolean Inherited from # Partial.pinned","title":"Interface: ConfirmDialogProps"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#interface-confirmdialogprops","text":"Renderer . Component .ConfirmDialogProps","title":"Interface: ConfirmDialogProps"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#hierarchy","text":"Partial < DialogProps > \u21b3 ConfirmDialogProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#properties","text":"animated children className close data-testid isOpen modal onClose onOpen open pinned","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#animated","text":"\u2022 Optional animated : boolean","title":"animated"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#children","text":"\u2022 Optional children : ReactNode | ReactNode []","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#close","text":"\u2022 Optional close : () => void","title":"close"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#isopen","text":"\u2022 Optional isOpen : boolean","title":"isOpen"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#modal","text":"\u2022 Optional modal : boolean","title":"modal"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#onclose","text":"\u2022 Optional onClose : () => void","title":"onClose"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#onopen","text":"\u2022 Optional onOpen : () => void","title":"onOpen"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#open","text":"\u2022 Optional open : () => void","title":"open"},{"location":"extensions/api/interfaces/Renderer.Component.ConfirmDialogProps/#pinned","text":"\u2022 Optional pinned : boolean","title":"pinned"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/","text":"Interface: CreateNotificationOptions # Renderer . Component .CreateNotificationOptions Table of contents # Properties # id timeout Methods # onClose Properties # id # \u2022 Optional id : NotificationId timeout # \u2022 Optional timeout : number Methods # onClose # \u25b8 Optional onClose (): void Returns # void","title":"Interface: CreateNotificationOptions"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#interface-createnotificationoptions","text":"Renderer . Component .CreateNotificationOptions","title":"Interface: CreateNotificationOptions"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#properties","text":"id timeout","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#methods","text":"onClose","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#id","text":"\u2022 Optional id : NotificationId","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#timeout","text":"\u2022 Optional timeout : number","title":"timeout"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.CreateNotificationOptions/#onclose","text":"\u25b8 Optional onClose (): void","title":"onClose"},{"location":"extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/","text":"Interface: CustomPlaceholderProps # Renderer . Component .CustomPlaceholderProps Hierarchy # PlaceholderProps < NamespaceSelectFilterOption , true > \u21b3 CustomPlaceholderProps","title":"Interface: CustomPlaceholderProps"},{"location":"extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/#interface-customplaceholderprops","text":"Renderer . Component .CustomPlaceholderProps","title":"Interface: CustomPlaceholderProps"},{"location":"extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/#hierarchy","text":"PlaceholderProps < NamespaceSelectFilterOption , true > \u21b3 CustomPlaceholderProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/","text":"Interface: DialogProps # Renderer . Component .DialogProps Table of contents # Properties # animated children className close data-testid isOpen modal onClose onOpen open pinned Properties # animated # \u2022 Optional animated : boolean children # \u2022 Optional children : ReactNode | ReactNode [] className # \u2022 Optional className : string close # \u2022 Optional close : () => void Type declaration # \u25b8 (): void Returns # void data-testid # \u2022 Optional data-testid : string isOpen # \u2022 Optional isOpen : boolean modal # \u2022 Optional modal : boolean onClose # \u2022 Optional onClose : () => void Type declaration # \u25b8 (): void Returns # void onOpen # \u2022 Optional onOpen : () => void Type declaration # \u25b8 (): void Returns # void open # \u2022 Optional open : () => void Type declaration # \u25b8 (): void Returns # void pinned # \u2022 Optional pinned : boolean","title":"Interface: DialogProps"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#interface-dialogprops","text":"Renderer . Component .DialogProps","title":"Interface: DialogProps"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#properties","text":"animated children className close data-testid isOpen modal onClose onOpen open pinned","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#animated","text":"\u2022 Optional animated : boolean","title":"animated"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#children","text":"\u2022 Optional children : ReactNode | ReactNode []","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#close","text":"\u2022 Optional close : () => void","title":"close"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#isopen","text":"\u2022 Optional isOpen : boolean","title":"isOpen"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#modal","text":"\u2022 Optional modal : boolean","title":"modal"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#onclose","text":"\u2022 Optional onClose : () => void","title":"onClose"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#onopen","text":"\u2022 Optional onOpen : () => void","title":"onOpen"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#open","text":"\u2022 Optional open : () => void","title":"open"},{"location":"extensions/api/interfaces/Renderer.Component.DialogProps/#pinned","text":"\u2022 Optional pinned : boolean","title":"pinned"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/","text":"Interface: DrawerItemLabelsProps # Renderer . Component .DrawerItemLabelsProps Hierarchy # DrawerItemProps \u21b3 DrawerItemLabelsProps Table of contents # Properties # hidden labels labelsOnly name renderBooleans title Properties # hidden # \u2022 Optional hidden : boolean Inherited from # DrawerItemProps . hidden labels # \u2022 labels : string [] | Partial < Record < string , string >> labelsOnly # \u2022 Optional labelsOnly : boolean Inherited from # DrawerItemProps . labelsOnly name # \u2022 name : ReactNode Inherited from # DrawerItemProps . name renderBooleans # \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. Inherited from # DrawerItemProps . renderBooleans title # \u2022 Optional title : string Inherited from # DrawerItemProps . title","title":"Interface: DrawerItemLabelsProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#interface-draweritemlabelsprops","text":"Renderer . Component .DrawerItemLabelsProps","title":"Interface: DrawerItemLabelsProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#hierarchy","text":"DrawerItemProps \u21b3 DrawerItemLabelsProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#properties","text":"hidden labels labelsOnly name renderBooleans title","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#labels","text":"\u2022 labels : string [] | Partial < Record < string , string >>","title":"labels"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#labelsonly","text":"\u2022 Optional labelsOnly : boolean","title":"labelsOnly"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#name","text":"\u2022 name : ReactNode","title":"name"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#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.","title":"renderBooleans"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemLabelsProps/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/","text":"Interface: DrawerItemProps # Renderer . Component .DrawerItemProps Hierarchy # HTMLAttributes < HTMLDivElement > \u21b3 DrawerItemProps \u21b3\u21b3 DrawerItemLabelsProps Table of contents # Properties # hidden labelsOnly name renderBooleans title Properties # hidden # \u2022 Optional hidden : boolean Overrides # React.HTMLAttributes.hidden labelsOnly # \u2022 Optional labelsOnly : boolean name # \u2022 name : ReactNode renderBooleans # \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. title # \u2022 Optional title : string Overrides # React.HTMLAttributes.title","title":"Interface: DrawerItemProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#interface-draweritemprops","text":"Renderer . Component .DrawerItemProps","title":"Interface: DrawerItemProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#hierarchy","text":"HTMLAttributes < HTMLDivElement > \u21b3 DrawerItemProps \u21b3\u21b3 DrawerItemLabelsProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#properties","text":"hidden labelsOnly name renderBooleans title","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#hidden","text":"\u2022 Optional hidden : boolean","title":"hidden"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#labelsonly","text":"\u2022 Optional labelsOnly : boolean","title":"labelsOnly"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#name","text":"\u2022 name : ReactNode","title":"name"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#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.","title":"renderBooleans"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerItemProps/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/","text":"Interface: DrawerParamTogglerProps # Renderer . Component .DrawerParamTogglerProps Table of contents # Properties # children label Properties # children # \u2022 children : ReactNode | ReactNode [] label # \u2022 label : string | number","title":"Interface: DrawerParamTogglerProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#interface-drawerparamtogglerprops","text":"Renderer . Component .DrawerParamTogglerProps","title":"Interface: DrawerParamTogglerProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#properties","text":"children label","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#children","text":"\u2022 children : ReactNode | ReactNode []","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerParamTogglerProps/#label","text":"\u2022 label : string | number","title":"label"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/","text":"Interface: DrawerProps # Renderer . Component .DrawerProps Table of contents # Properties # animation children className contentClass data-testid onClose open position size testIdForClose title toolbar usePortal Properties # animation # \u2022 Optional animation : string children # \u2022 Optional children : SingleOrMany < ReactNode > className # \u2022 Optional className : string | object contentClass # \u2022 Optional contentClass : string | object data-testid # \u2022 Optional data-testid : string onClose # \u2022 Optional onClose : () => void Type declaration # \u25b8 (): void Returns # void open # \u2022 open : boolean position # \u2022 Optional position : DrawerPosition size # \u2022 Optional size : string The width or heigh (depending on position ) of the Drawer. If not set then the Drawer will be resizable. testIdForClose # \u2022 Optional testIdForClose : string title # \u2022 title : ReactNode toolbar # \u2022 Optional toolbar : ReactNode usePortal # \u2022 Optional usePortal : boolean","title":"Interface: DrawerProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#interface-drawerprops","text":"Renderer . Component .DrawerProps","title":"Interface: DrawerProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#properties","text":"animation children className contentClass data-testid onClose open position size testIdForClose title toolbar usePortal","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#animation","text":"\u2022 Optional animation : string","title":"animation"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#children","text":"\u2022 Optional children : SingleOrMany < ReactNode >","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#classname","text":"\u2022 Optional className : string | object","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#contentclass","text":"\u2022 Optional contentClass : string | object","title":"contentClass"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#onclose","text":"\u2022 Optional onClose : () => void","title":"onClose"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#open","text":"\u2022 open : boolean","title":"open"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#position","text":"\u2022 Optional position : DrawerPosition","title":"position"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#size","text":"\u2022 Optional size : string The width or heigh (depending on position ) of the Drawer. If not set then the Drawer will be resizable.","title":"size"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#testidforclose","text":"\u2022 Optional testIdForClose : string","title":"testIdForClose"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#title","text":"\u2022 title : ReactNode","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#toolbar","text":"\u2022 Optional toolbar : ReactNode","title":"toolbar"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerProps/#useportal","text":"\u2022 Optional usePortal : boolean","title":"usePortal"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/","text":"Interface: DrawerTitleProps # Renderer . Component .DrawerTitleProps Table of contents # Properties # children className size title Properties # children # \u2022 Optional children : ReactNode className # \u2022 Optional className : string size # \u2022 Optional size : \"title\" | \"sub-title\" Specifies how large this title is Default \"title\" title # \u2022 Optional title : ReactNode Deprecated Prefer passing the value as children","title":"Interface: DrawerTitleProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#interface-drawertitleprops","text":"Renderer . Component .DrawerTitleProps","title":"Interface: DrawerTitleProps"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#properties","text":"children className size title","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#size","text":"\u2022 Optional size : \"title\" | \"sub-title\" Specifies how large this title is Default \"title\"","title":"size"},{"location":"extensions/api/interfaces/Renderer.Component.DrawerTitleProps/#title","text":"\u2022 Optional title : ReactNode Deprecated Prefer passing the value as children","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/","text":"Interface: IconDataFnArg # Renderer . Component .IconDataFnArg Table of contents # Properties # isDirty Properties # isDirty # \u2022 isDirty : boolean","title":"Interface: IconDataFnArg"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#interface-icondatafnarg","text":"Renderer . Component .IconDataFnArg","title":"Interface: IconDataFnArg"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#properties","text":"isDirty","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.IconDataFnArg/#isdirty","text":"\u2022 isDirty : boolean","title":"isDirty"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/","text":"Interface: IconProps # Renderer . Component .IconProps Hierarchy # HTMLAttributes < any > BaseIconProps \u21b3 IconProps Table of contents # Properties # active big data-testid disabled focusable href interactive link material size small smallest sticker svg Properties # active # \u2022 Optional active : boolean apply active-state styles Inherited from # BaseIconProps . active big # \u2022 Optional big : boolean A pre-defined icon-size Inherited from # BaseIconProps . big data-testid # \u2022 Optional data-testid : string Inherited from # BaseIconProps . data-testid disabled # \u2022 Optional disabled : boolean Inherited from # BaseIconProps . disabled focusable # \u2022 Optional focusable : boolean Allow focus to the icon to show .active styles. Only applicable if interactive is true . Default true Inherited from # BaseIconProps . focusable href # \u2022 Optional href : string render icon as hyperlink Inherited from # BaseIconProps . href interactive # \u2022 Optional interactive : boolean indicates that icon is interactive and highlight it on focus/hover Inherited from # BaseIconProps . interactive link # \u2022 Optional link : LocationDescriptor < unknown > render icon as NavLink from react-router-dom Inherited from # BaseIconProps . link material # \u2022 Optional material : string One of the names from https://material.io/icons/ Inherited from # BaseIconProps . material size # \u2022 Optional size : string | number The icon size (css units) Inherited from # BaseIconProps . size small # \u2022 Optional small : boolean A pre-defined icon-size Inherited from # BaseIconProps . small smallest # \u2022 Optional smallest : boolean A pre-defined icon-size Inherited from # BaseIconProps . smallest sticker # \u2022 Optional sticker : boolean Inherited from # BaseIconProps . sticker svg # \u2022 Optional svg : string Either an SVG XML or one of the following names - 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 Inherited from # BaseIconProps . svg","title":"Interface: IconProps"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#interface-iconprops","text":"Renderer . Component .IconProps","title":"Interface: IconProps"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#hierarchy","text":"HTMLAttributes < any > BaseIconProps \u21b3 IconProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#properties","text":"active big data-testid disabled focusable href interactive link material size small smallest sticker svg","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#active","text":"\u2022 Optional active : boolean apply active-state styles","title":"active"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#big","text":"\u2022 Optional big : boolean A pre-defined icon-size","title":"big"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#focusable","text":"\u2022 Optional focusable : boolean Allow focus to the icon to show .active styles. Only applicable if interactive is true . Default true","title":"focusable"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#href","text":"\u2022 Optional href : string render icon as hyperlink","title":"href"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#interactive","text":"\u2022 Optional interactive : boolean indicates that icon is interactive and highlight it on focus/hover","title":"interactive"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#link","text":"\u2022 Optional link : LocationDescriptor < unknown > render icon as NavLink from react-router-dom","title":"link"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#material","text":"\u2022 Optional material : string One of the names from https://material.io/icons/","title":"material"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#size","text":"\u2022 Optional size : string | number The icon size (css units)","title":"size"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#small","text":"\u2022 Optional small : boolean A pre-defined icon-size","title":"small"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#smallest","text":"\u2022 Optional smallest : boolean A pre-defined icon-size","title":"smallest"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#sticker","text":"\u2022 Optional sticker : boolean","title":"sticker"},{"location":"extensions/api/interfaces/Renderer.Component.IconProps/#svg","text":"\u2022 Optional svg : string Either an SVG XML or one of the following names - 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","title":"svg"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/","text":"Interface: KubeEventDetailsProps # Renderer . Component .KubeEventDetailsProps Table of contents # Properties # object Properties # object # \u2022 object : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >","title":"Interface: KubeEventDetailsProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#interface-kubeeventdetailsprops","text":"Renderer . Component .KubeEventDetailsProps","title":"Interface: KubeEventDetailsProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#properties","text":"object","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeEventDetailsProps/#object","text":"\u2022 object : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >","title":"object"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/","text":"Interface: KubeObjectDetailsProps # Renderer . Component .KubeObjectDetailsProps Type parameters # Name Type Kube extends KubeObject = KubeObject Table of contents # Properties # className object Properties # className # \u2022 Optional className : string object # \u2022 object : Kube","title":"Interface: KubeObjectDetailsProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#interface-kubeobjectdetailspropskube","text":"Renderer . Component .KubeObjectDetailsProps","title":"Interface: KubeObjectDetailsProps<Kube>"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#type-parameters","text":"Name Type Kube extends KubeObject = KubeObject","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#properties","text":"className object","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectDetailsProps/#object","text":"\u2022 object : Kube","title":"object"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/","text":"Interface: KubeObjectListLayoutProps # Renderer . Component .KubeObjectListLayoutProps Type parameters # Name Type K extends KubeObject A extends KubeApi < K , D > D extends KubeJsonApiDataFor < K > Hierarchy # Omit < ItemListLayoutProps < K , false >, \"getItems\" | \"dependentStores\" | \"preloadStores\" > \u21b3 KubeObjectListLayoutProps Table of contents # Properties # addRemoveButtons className copyClassNameFromHeadCells customizeHeader customizeRemoveDialog customizeTableRowProps data-testid dependentStores detailsItem failedToLoadMessage filterCallbacks filterItems getItems hasDetailsView headerClassName hideFilters isConfigurable isReady isSelectable items onDetails renderFooter renderHeaderTitle renderItemMenu renderTableContents renderTableHeader resourceName searchFilters showHeader sortingCallbacks spinnerTestId store subscribeStores tableId tableProps virtual Properties # addRemoveButtons # \u2022 Optional addRemoveButtons : Partial < AddRemoveButtonsProps > Inherited from # Omit.addRemoveButtons className # \u2022 className : IClassName Inherited from # Omit.className copyClassNameFromHeadCells # \u2022 Optional copyClassNameFromHeadCells : boolean Inherited from # Omit.copyClassNameFromHeadCells customizeHeader # \u2022 Optional customizeHeader : HeaderCustomizer | HeaderCustomizer [] Inherited from # Omit.customizeHeader customizeRemoveDialog # \u2022 Optional customizeRemoveDialog : ( selectedItems : K []) => Partial < ConfirmDialogParams > Type declaration # \u25b8 ( selectedItems ): Partial < ConfirmDialogParams > Parameters # Name Type selectedItems K [] Returns # Partial < ConfirmDialogParams > Inherited from # Omit.customizeRemoveDialog customizeTableRowProps # \u2022 Optional customizeTableRowProps : ( item : K ) => Partial < TableRowProps < K >> Type declaration # \u25b8 ( item ): Partial < TableRowProps < K >> Parameters # Name Type item K Returns # Partial < TableRowProps < K >> Inherited from # Omit.customizeTableRowProps data-testid # \u2022 Optional data-testid : string Inherited from # Omit.data-testid dependentStores # \u2022 Optional dependentStores : SubscribableStore [] detailsItem # \u2022 Optional detailsItem : K Inherited from # Omit.detailsItem failedToLoadMessage # \u2022 Optional failedToLoadMessage : ReactNode Message to display when a store failed to load Default \"Failed to load items\" Inherited from # Omit.failedToLoadMessage filterCallbacks # \u2022 Optional filterCallbacks : ItemsFilters < K > Inherited from # Omit.filterCallbacks filterItems # \u2022 Optional filterItems : ItemsFilter < K >[] Deprecated Inherited from # Omit.filterItems getItems # \u2022 Optional getItems : () => K [] Type declaration # \u25b8 (): K [] Returns # K [] hasDetailsView # \u2022 Optional hasDetailsView : boolean Inherited from # Omit.hasDetailsView headerClassName # \u2022 Optional headerClassName : IClassName Inherited from # Omit.headerClassName hideFilters # \u2022 Optional hideFilters : boolean Inherited from # Omit.hideFilters isConfigurable # \u2022 Optional isConfigurable : boolean Inherited from # Omit.isConfigurable isReady # \u2022 Optional isReady : boolean Inherited from # Omit.isReady isSelectable # \u2022 Optional isSelectable : boolean Inherited from # Omit.isSelectable items # \u2022 Optional items : K [] onDetails # \u2022 Optional onDetails : ( item : K ) => void Type declaration # \u25b8 ( item ): void Parameters # Name Type item K Returns # void Inherited from # Omit.onDetails renderFooter # \u2022 Optional renderFooter : ( parent : NonInjectedItemListLayout < K , false >) => ReactNode Type declaration # \u25b8 ( parent ): ReactNode Parameters # Name Type parent NonInjectedItemListLayout < K , false > Returns # ReactNode Inherited from # Omit.renderFooter renderHeaderTitle # \u2022 Optional renderHeaderTitle : RenderHeaderTitle < K , false > Inherited from # Omit.renderHeaderTitle renderItemMenu # \u2022 Optional renderItemMenu : ( item : K , store : ItemListStore < K , false >) => ReactNode Type declaration # \u25b8 ( item , store ): ReactNode Parameters # Name Type item K store ItemListStore < K , false > Returns # ReactNode Inherited from # Omit.renderItemMenu renderTableContents # \u2022 renderTableContents : ( item : K ) => ( ReactNode | TableCellProps )[] Type declaration # \u25b8 ( item ): ( ReactNode | TableCellProps )[] Parameters # Name Type item K Returns # ( ReactNode | TableCellProps )[] Inherited from # Omit.renderTableContents renderTableHeader # \u2022 Optional renderTableHeader : ( undefined | null | TableCellProps )[] Inherited from # Omit.renderTableHeader resourceName # \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. searchFilters # \u2022 Optional searchFilters : SearchFilter < K >[] Inherited from # Omit.searchFilters showHeader # \u2022 Optional showHeader : boolean Inherited from # Omit.showHeader sortingCallbacks # \u2022 Optional sortingCallbacks : TableSortCallbacks < K > Inherited from # Omit.sortingCallbacks spinnerTestId # \u2022 Optional spinnerTestId : string Inherited from # Omit.spinnerTestId store # \u2022 store : KubeObjectStore < K , A , D > Overrides # Omit.store subscribeStores # \u2022 Optional subscribeStores : boolean tableId # \u2022 Optional tableId : string Inherited from # Omit.tableId tableProps # \u2022 Optional tableProps : Partial < TableProps < K >> Inherited from # Omit.tableProps virtual # \u2022 Optional virtual : boolean Inherited from # Omit.virtual","title":"Interface: KubeObjectListLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#interface-kubeobjectlistlayoutpropsk-a-d","text":"Renderer . Component .KubeObjectListLayoutProps","title":"Interface: KubeObjectListLayoutProps<K, A, D>"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#type-parameters","text":"Name Type K extends KubeObject A extends KubeApi < K , D > D extends KubeJsonApiDataFor < K >","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#hierarchy","text":"Omit < ItemListLayoutProps < K , false >, \"getItems\" | \"dependentStores\" | \"preloadStores\" > \u21b3 KubeObjectListLayoutProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#properties","text":"addRemoveButtons className copyClassNameFromHeadCells customizeHeader customizeRemoveDialog customizeTableRowProps data-testid dependentStores detailsItem failedToLoadMessage filterCallbacks filterItems getItems hasDetailsView headerClassName hideFilters isConfigurable isReady isSelectable items onDetails renderFooter renderHeaderTitle renderItemMenu renderTableContents renderTableHeader resourceName searchFilters showHeader sortingCallbacks spinnerTestId store subscribeStores tableId tableProps virtual","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#addremovebuttons","text":"\u2022 Optional addRemoveButtons : Partial < AddRemoveButtonsProps >","title":"addRemoveButtons"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#classname","text":"\u2022 className : IClassName","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#copyclassnamefromheadcells","text":"\u2022 Optional copyClassNameFromHeadCells : boolean","title":"copyClassNameFromHeadCells"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#customizeheader","text":"\u2022 Optional customizeHeader : HeaderCustomizer | HeaderCustomizer []","title":"customizeHeader"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#customizeremovedialog","text":"\u2022 Optional customizeRemoveDialog : ( selectedItems : K []) => Partial < ConfirmDialogParams >","title":"customizeRemoveDialog"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#customizetablerowprops","text":"\u2022 Optional customizeTableRowProps : ( item : K ) => Partial < TableRowProps < K >>","title":"customizeTableRowProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#dependentstores","text":"\u2022 Optional dependentStores : SubscribableStore []","title":"dependentStores"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#detailsitem","text":"\u2022 Optional detailsItem : K","title":"detailsItem"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#failedtoloadmessage","text":"\u2022 Optional failedToLoadMessage : ReactNode Message to display when a store failed to load Default \"Failed to load items\"","title":"failedToLoadMessage"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#filtercallbacks","text":"\u2022 Optional filterCallbacks : ItemsFilters < K >","title":"filterCallbacks"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#filteritems","text":"\u2022 Optional filterItems : ItemsFilter < K >[] Deprecated","title":"filterItems"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#getitems","text":"\u2022 Optional getItems : () => K []","title":"getItems"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#hasdetailsview","text":"\u2022 Optional hasDetailsView : boolean","title":"hasDetailsView"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#headerclassname","text":"\u2022 Optional headerClassName : IClassName","title":"headerClassName"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#hidefilters","text":"\u2022 Optional hideFilters : boolean","title":"hideFilters"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#isconfigurable","text":"\u2022 Optional isConfigurable : boolean","title":"isConfigurable"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#isready","text":"\u2022 Optional isReady : boolean","title":"isReady"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#isselectable","text":"\u2022 Optional isSelectable : boolean","title":"isSelectable"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#items","text":"\u2022 Optional items : K []","title":"items"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#ondetails","text":"\u2022 Optional onDetails : ( item : K ) => void","title":"onDetails"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#renderfooter","text":"\u2022 Optional renderFooter : ( parent : NonInjectedItemListLayout < K , false >) => ReactNode","title":"renderFooter"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#renderheadertitle","text":"\u2022 Optional renderHeaderTitle : RenderHeaderTitle < K , false >","title":"renderHeaderTitle"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#renderitemmenu","text":"\u2022 Optional renderItemMenu : ( item : K , store : ItemListStore < K , false >) => ReactNode","title":"renderItemMenu"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#rendertablecontents","text":"\u2022 renderTableContents : ( item : K ) => ( ReactNode | TableCellProps )[]","title":"renderTableContents"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#rendertableheader","text":"\u2022 Optional renderTableHeader : ( undefined | null | TableCellProps )[]","title":"renderTableHeader"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#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.","title":"resourceName"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#searchfilters","text":"\u2022 Optional searchFilters : SearchFilter < K >[]","title":"searchFilters"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#showheader","text":"\u2022 Optional showHeader : boolean","title":"showHeader"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#sortingcallbacks","text":"\u2022 Optional sortingCallbacks : TableSortCallbacks < K >","title":"sortingCallbacks"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#spinnertestid","text":"\u2022 Optional spinnerTestId : string","title":"spinnerTestId"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#store","text":"\u2022 store : KubeObjectStore < K , A , D >","title":"store"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#subscribestores","text":"\u2022 Optional subscribeStores : boolean","title":"subscribeStores"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#tableid","text":"\u2022 Optional tableId : string","title":"tableId"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#tableprops","text":"\u2022 Optional tableProps : Partial < TableProps < K >>","title":"tableProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectListLayoutProps/#virtual","text":"\u2022 Optional virtual : boolean","title":"virtual"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/","text":"Interface: KubeObjectMenuProps # Renderer . Component .KubeObjectMenuProps Type parameters # Name Type TKubeObject extends KubeObject Hierarchy # MenuActionsProps \u21b3 KubeObjectMenuProps Table of contents # Properties # animated autoCloseOnSelect autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll data-testid editable htmlFor id isOpen object onOpen position removable removeAction removeConfirmationMessage toggleEvent toolbar triggerIcon updateAction usePortal Methods # close open Properties # animated # \u2022 Optional animated : boolean Inherited from # MenuActionsProps . animated autoCloseOnSelect # \u2022 Optional autoCloseOnSelect : boolean Inherited from # MenuActionsProps . autoCloseOnSelect autoFocus # \u2022 Optional autoFocus : boolean Inherited from # MenuActionsProps . autoFocus children # \u2022 Optional children : ReactNode Inherited from # MenuActionsProps . children className # \u2022 Optional className : string Inherited from # MenuActionsProps . className closeOnClickItem # \u2022 Optional closeOnClickItem : boolean Inherited from # MenuActionsProps . closeOnClickItem closeOnClickOutside # \u2022 Optional closeOnClickOutside : boolean Inherited from # MenuActionsProps . closeOnClickOutside closeOnScroll # \u2022 Optional closeOnScroll : boolean Inherited from # MenuActionsProps . closeOnScroll data-testid # \u2022 Optional data-testid : string Inherited from # MenuActionsProps . data-testid editable # \u2022 Optional editable : boolean htmlFor # \u2022 Optional htmlFor : string Inherited from # MenuActionsProps . htmlFor id # \u2022 Optional id : string Inherited from # MenuActionsProps . id isOpen # \u2022 Optional isOpen : boolean Inherited from # MenuActionsProps . isOpen object # \u2022 object : TKubeObject onOpen # \u2022 Optional onOpen : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # MenuActionsProps . onOpen position # \u2022 Optional position : MenuPosition Inherited from # MenuActionsProps . position removable # \u2022 Optional removable : boolean removeAction # \u2022 Optional removeAction : () => void | Promise < void > Type declaration # \u25b8 (): void | Promise < void > Deprecated Provide your own remove as part of the children passed to this component Returns # void | Promise < void > Inherited from # MenuActionsProps . removeAction removeConfirmationMessage # \u2022 Optional removeConfirmationMessage : ReactNode | () => ReactNode Deprecated Provide your own remove as part of the children passed to this component Inherited from # MenuActionsProps . removeConfirmationMessage toggleEvent # \u2022 Optional toggleEvent : \"click\" | \"contextmenu\" Inherited from # MenuActionsProps . toggleEvent toolbar # \u2022 Optional toolbar : boolean Inherited from # MenuActionsProps . toolbar triggerIcon # \u2022 Optional triggerIcon : ReactNode | IconProps & TooltipDecoratorProps Inherited from # MenuActionsProps . triggerIcon updateAction # \u2022 Optional updateAction : () => void | Promise < void > Type declaration # \u25b8 (): void | Promise < void > Deprecated Provide your own update as part of the children passed to this component Returns # void | Promise < void > Inherited from # MenuActionsProps . updateAction usePortal # \u2022 Optional usePortal : boolean | HTMLElement Inherited from # MenuActionsProps . usePortal Methods # close # \u25b8 Optional close (): void Returns # void Inherited from # MenuActionsProps . close open # \u25b8 Optional open (): void Returns # void Inherited from # MenuActionsProps . open","title":"Interface: KubeObjectMenuProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#interface-kubeobjectmenupropstkubeobject","text":"Renderer . Component .KubeObjectMenuProps","title":"Interface: KubeObjectMenuProps<TKubeObject>"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#type-parameters","text":"Name Type TKubeObject extends KubeObject","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#hierarchy","text":"MenuActionsProps \u21b3 KubeObjectMenuProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#properties","text":"animated autoCloseOnSelect autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll data-testid editable htmlFor id isOpen object onOpen position removable removeAction removeConfirmationMessage toggleEvent toolbar triggerIcon updateAction usePortal","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#methods","text":"close open","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#animated","text":"\u2022 Optional animated : boolean","title":"animated"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#autocloseonselect","text":"\u2022 Optional autoCloseOnSelect : boolean","title":"autoCloseOnSelect"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#closeonclickitem","text":"\u2022 Optional closeOnClickItem : boolean","title":"closeOnClickItem"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#closeonclickoutside","text":"\u2022 Optional closeOnClickOutside : boolean","title":"closeOnClickOutside"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#closeonscroll","text":"\u2022 Optional closeOnScroll : boolean","title":"closeOnScroll"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#editable","text":"\u2022 Optional editable : boolean","title":"editable"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#htmlfor","text":"\u2022 Optional htmlFor : string","title":"htmlFor"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#isopen","text":"\u2022 Optional isOpen : boolean","title":"isOpen"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#object","text":"\u2022 object : TKubeObject","title":"object"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#onopen","text":"\u2022 Optional onOpen : () => void","title":"onOpen"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#position","text":"\u2022 Optional position : MenuPosition","title":"position"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#removable","text":"\u2022 Optional removable : boolean","title":"removable"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#removeaction","text":"\u2022 Optional removeAction : () => void | Promise < void >","title":"removeAction"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#removeconfirmationmessage","text":"\u2022 Optional removeConfirmationMessage : ReactNode | () => ReactNode Deprecated Provide your own remove as part of the children passed to this component","title":"removeConfirmationMessage"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#toggleevent","text":"\u2022 Optional toggleEvent : \"click\" | \"contextmenu\"","title":"toggleEvent"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#toolbar","text":"\u2022 Optional toolbar : boolean","title":"toolbar"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#triggericon","text":"\u2022 Optional triggerIcon : ReactNode | IconProps & TooltipDecoratorProps","title":"triggerIcon"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#updateaction","text":"\u2022 Optional updateAction : () => void | Promise < void >","title":"updateAction"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#useportal","text":"\u2022 Optional usePortal : boolean | HTMLElement","title":"usePortal"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#close","text":"\u25b8 Optional close (): void","title":"close"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/#open","text":"\u25b8 Optional open (): void","title":"open"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/","text":"Interface: KubeObjectMetaProps # Renderer . Component .KubeObjectMetaProps Table of contents # Properties # hideFields object Properties # hideFields # \u2022 Optional hideFields : keyof BaseKubeJsonApiObjectMetadata < KubeObjectScope >[] object # \u2022 object : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >","title":"Interface: KubeObjectMetaProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#interface-kubeobjectmetaprops","text":"Renderer . Component .KubeObjectMetaProps","title":"Interface: KubeObjectMetaProps"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#properties","text":"hideFields object","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#hidefields","text":"\u2022 Optional hideFields : keyof BaseKubeJsonApiObjectMetadata < KubeObjectScope >[]","title":"hideFields"},{"location":"extensions/api/interfaces/Renderer.Component.KubeObjectMetaProps/#object","text":"\u2022 object : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >","title":"object"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/","text":"Interface: LineProgressProps # Renderer . Component .LineProgressProps Hierarchy # HTMLProps < HTMLDivElement > \u21b3 LineProgressProps Table of contents # Properties # className max min precise value Properties # className # \u2022 Optional className : any Overrides # React.HTMLProps.className max # \u2022 Optional max : number Overrides # React.HTMLProps.max min # \u2022 Optional min : number Overrides # React.HTMLProps.min precise # \u2022 Optional precise : number value # \u2022 value : number Overrides # React.HTMLProps.value","title":"Interface: LineProgressProps"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#interface-lineprogressprops","text":"Renderer . Component .LineProgressProps","title":"Interface: LineProgressProps"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#hierarchy","text":"HTMLProps < HTMLDivElement > \u21b3 LineProgressProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#properties","text":"className max min precise value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#classname","text":"\u2022 Optional className : any","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#max","text":"\u2022 Optional max : number","title":"max"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#min","text":"\u2022 Optional min : number","title":"min"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#precise","text":"\u2022 Optional precise : number","title":"precise"},{"location":"extensions/api/interfaces/Renderer.Component.LineProgressProps/#value","text":"\u2022 value : number","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/","text":"Interface: MainLayoutProps # Renderer . Component .MainLayoutProps Table of contents # Properties # children className footer sidebar Properties # children # \u2022 Optional children : ReactNode | ReactNode [] className # \u2022 Optional className : string footer # \u2022 Optional footer : ReactNode sidebar # \u2022 sidebar : ReactNode","title":"Interface: MainLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#interface-mainlayoutprops","text":"Renderer . Component .MainLayoutProps","title":"Interface: MainLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#properties","text":"children className footer sidebar","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#children","text":"\u2022 Optional children : ReactNode | ReactNode []","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#footer","text":"\u2022 Optional footer : ReactNode","title":"footer"},{"location":"extensions/api/interfaces/Renderer.Component.MainLayoutProps/#sidebar","text":"\u2022 sidebar : ReactNode","title":"sidebar"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/","text":"Interface: MenuActionsProps # Renderer . Component .MenuActionsProps Hierarchy # Partial < MenuProps > \u21b3 MenuActionsProps \u21b3\u21b3 KubeObjectMenuProps Table of contents # Properties # animated autoCloseOnSelect autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll data-testid htmlFor id isOpen onOpen position removeAction removeConfirmationMessage toggleEvent toolbar triggerIcon updateAction usePortal Methods # close open Properties # animated # \u2022 Optional animated : boolean Inherited from # Partial.animated autoCloseOnSelect # \u2022 Optional autoCloseOnSelect : boolean autoFocus # \u2022 Optional autoFocus : boolean Inherited from # Partial.autoFocus children # \u2022 Optional children : ReactNode Inherited from # Partial.children className # \u2022 Optional className : string Overrides # Partial.className closeOnClickItem # \u2022 Optional closeOnClickItem : boolean Inherited from # Partial.closeOnClickItem closeOnClickOutside # \u2022 Optional closeOnClickOutside : boolean Inherited from # Partial.closeOnClickOutside closeOnScroll # \u2022 Optional closeOnScroll : boolean Inherited from # Partial.closeOnScroll data-testid # \u2022 Optional data-testid : string Inherited from # Partial.data-testid htmlFor # \u2022 Optional htmlFor : string Inherited from # Partial.htmlFor id # \u2022 Optional id : string Overrides # Partial.id isOpen # \u2022 Optional isOpen : boolean Inherited from # Partial.isOpen onOpen # \u2022 Optional onOpen : () => void Type declaration # \u25b8 (): void Returns # void position # \u2022 Optional position : MenuPosition Inherited from # Partial.position removeAction # \u2022 Optional removeAction : () => void | Promise < void > Type declaration # \u25b8 (): void | Promise < void > Deprecated Provide your own remove as part of the children passed to this component Returns # void | Promise < void > removeConfirmationMessage # \u2022 Optional removeConfirmationMessage : ReactNode | () => ReactNode Deprecated Provide your own remove as part of the children passed to this component toggleEvent # \u2022 Optional toggleEvent : \"click\" | \"contextmenu\" Inherited from # Partial.toggleEvent toolbar # \u2022 Optional toolbar : boolean triggerIcon # \u2022 Optional triggerIcon : ReactNode | IconProps & TooltipDecoratorProps updateAction # \u2022 Optional updateAction : () => void | Promise < void > Type declaration # \u25b8 (): void | Promise < void > Deprecated Provide your own update as part of the children passed to this component Returns # void | Promise < void > usePortal # \u2022 Optional usePortal : boolean | HTMLElement Inherited from # Partial.usePortal Methods # close # \u25b8 Optional close (): void Returns # void Inherited from # Partial.close open # \u25b8 Optional open (): void Returns # void Inherited from # Partial.open","title":"Interface: MenuActionsProps"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#interface-menuactionsprops","text":"Renderer . Component .MenuActionsProps","title":"Interface: MenuActionsProps"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#hierarchy","text":"Partial < MenuProps > \u21b3 MenuActionsProps \u21b3\u21b3 KubeObjectMenuProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#properties","text":"animated autoCloseOnSelect autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll data-testid htmlFor id isOpen onOpen position removeAction removeConfirmationMessage toggleEvent toolbar triggerIcon updateAction usePortal","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#methods","text":"close open","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#animated","text":"\u2022 Optional animated : boolean","title":"animated"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#autocloseonselect","text":"\u2022 Optional autoCloseOnSelect : boolean","title":"autoCloseOnSelect"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#closeonclickitem","text":"\u2022 Optional closeOnClickItem : boolean","title":"closeOnClickItem"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#closeonclickoutside","text":"\u2022 Optional closeOnClickOutside : boolean","title":"closeOnClickOutside"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#closeonscroll","text":"\u2022 Optional closeOnScroll : boolean","title":"closeOnScroll"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#htmlfor","text":"\u2022 Optional htmlFor : string","title":"htmlFor"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#isopen","text":"\u2022 Optional isOpen : boolean","title":"isOpen"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#onopen","text":"\u2022 Optional onOpen : () => void","title":"onOpen"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#position","text":"\u2022 Optional position : MenuPosition","title":"position"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#removeaction","text":"\u2022 Optional removeAction : () => void | Promise < void >","title":"removeAction"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#removeconfirmationmessage","text":"\u2022 Optional removeConfirmationMessage : ReactNode | () => ReactNode Deprecated Provide your own remove as part of the children passed to this component","title":"removeConfirmationMessage"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#toggleevent","text":"\u2022 Optional toggleEvent : \"click\" | \"contextmenu\"","title":"toggleEvent"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#toolbar","text":"\u2022 Optional toolbar : boolean","title":"toolbar"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#triggericon","text":"\u2022 Optional triggerIcon : ReactNode | IconProps & TooltipDecoratorProps","title":"triggerIcon"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#updateaction","text":"\u2022 Optional updateAction : () => void | Promise < void >","title":"updateAction"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#useportal","text":"\u2022 Optional usePortal : boolean | HTMLElement","title":"usePortal"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#close","text":"\u25b8 Optional close (): void","title":"close"},{"location":"extensions/api/interfaces/Renderer.Component.MenuActionsProps/#open","text":"\u25b8 Optional open (): void","title":"open"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/","text":"Interface: MenuContextValue # Renderer . Component .MenuContextValue Table of contents # Properties # close props Properties # close # \u2022 close : () => void Type declaration # \u25b8 (): void Returns # void props # \u2022 Readonly props : Readonly < MenuProps >","title":"Interface: MenuContextValue"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#interface-menucontextvalue","text":"Renderer . Component .MenuContextValue","title":"Interface: MenuContextValue"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#properties","text":"close props","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#close","text":"\u2022 close : () => void","title":"close"},{"location":"extensions/api/interfaces/Renderer.Component.MenuContextValue/#props","text":"\u2022 Readonly props : Readonly < MenuProps >","title":"props"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/","text":"Interface: MenuItemProps # Renderer . Component .MenuItemProps Hierarchy # HTMLProps < any > \u21b3 MenuItemProps Table of contents # Properties # active disabled href icon spacer Properties # active # \u2022 Optional active : boolean disabled # \u2022 Optional disabled : boolean Overrides # React.HTMLProps.disabled href # \u2022 Optional href : string Overrides # React.HTMLProps.href icon # \u2022 Optional icon : string | Partial < IconProps > spacer # \u2022 Optional spacer : boolean","title":"Interface: MenuItemProps"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#interface-menuitemprops","text":"Renderer . Component .MenuItemProps","title":"Interface: MenuItemProps"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#hierarchy","text":"HTMLProps < any > \u21b3 MenuItemProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#properties","text":"active disabled href icon spacer","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#href","text":"\u2022 Optional href : string","title":"href"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#icon","text":"\u2022 Optional icon : string | Partial < IconProps >","title":"icon"},{"location":"extensions/api/interfaces/Renderer.Component.MenuItemProps/#spacer","text":"\u2022 Optional spacer : boolean","title":"spacer"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/","text":"Interface: MenuPosition # Renderer . Component .MenuPosition Table of contents # Properties # bottom left right top Properties # bottom # \u2022 Optional bottom : boolean left # \u2022 Optional left : boolean right # \u2022 Optional right : boolean top # \u2022 Optional top : boolean","title":"Interface: MenuPosition"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#interface-menuposition","text":"Renderer . Component .MenuPosition","title":"Interface: MenuPosition"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#properties","text":"bottom left right top","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#bottom","text":"\u2022 Optional bottom : boolean","title":"bottom"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#left","text":"\u2022 Optional left : boolean","title":"left"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#right","text":"\u2022 Optional right : boolean","title":"right"},{"location":"extensions/api/interfaces/Renderer.Component.MenuPosition/#top","text":"\u2022 Optional top : boolean","title":"top"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/","text":"Interface: MenuProps # Renderer . Component .MenuProps Table of contents # Properties # animated autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll data-testid htmlFor id isOpen position toggleEvent usePortal Methods # close open Properties # animated # \u2022 Optional animated : boolean autoFocus # \u2022 Optional autoFocus : boolean children # \u2022 Optional children : ReactNode className # \u2022 Optional className : string closeOnClickItem # \u2022 Optional closeOnClickItem : boolean closeOnClickOutside # \u2022 Optional closeOnClickOutside : boolean closeOnScroll # \u2022 Optional closeOnScroll : boolean data-testid # \u2022 Optional data-testid : string htmlFor # \u2022 Optional htmlFor : string id # \u2022 Optional id : string isOpen # \u2022 Optional isOpen : boolean position # \u2022 Optional position : MenuPosition toggleEvent # \u2022 Optional toggleEvent : \"click\" | \"contextmenu\" usePortal # \u2022 Optional usePortal : boolean | HTMLElement Methods # close # \u25b8 close (): void Returns # void open # \u25b8 open (): void Returns # void","title":"Interface: MenuProps"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#interface-menuprops","text":"Renderer . Component .MenuProps","title":"Interface: MenuProps"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#properties","text":"animated autoFocus children className closeOnClickItem closeOnClickOutside closeOnScroll data-testid htmlFor id isOpen position toggleEvent usePortal","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#methods","text":"close open","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#animated","text":"\u2022 Optional animated : boolean","title":"animated"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#closeonclickitem","text":"\u2022 Optional closeOnClickItem : boolean","title":"closeOnClickItem"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#closeonclickoutside","text":"\u2022 Optional closeOnClickOutside : boolean","title":"closeOnClickOutside"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#closeonscroll","text":"\u2022 Optional closeOnScroll : boolean","title":"closeOnScroll"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#htmlfor","text":"\u2022 Optional htmlFor : string","title":"htmlFor"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#isopen","text":"\u2022 Optional isOpen : boolean","title":"isOpen"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#position","text":"\u2022 Optional position : MenuPosition","title":"position"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#toggleevent","text":"\u2022 Optional toggleEvent : \"click\" | \"contextmenu\"","title":"toggleEvent"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#useportal","text":"\u2022 Optional usePortal : boolean | HTMLElement","title":"usePortal"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#close","text":"\u25b8 close (): void","title":"close"},{"location":"extensions/api/interfaces/Renderer.Component.MenuProps/#open","text":"\u25b8 open (): void","title":"open"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/","text":"Interface: MenuStyle # Renderer . Component .MenuStyle Table of contents # Properties # left top Properties # left # \u2022 left : string top # \u2022 top : string","title":"Interface: MenuStyle"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#interface-menustyle","text":"Renderer . Component .MenuStyle","title":"Interface: MenuStyle"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#properties","text":"left top","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#left","text":"\u2022 left : string","title":"left"},{"location":"extensions/api/interfaces/Renderer.Component.MenuStyle/#top","text":"\u2022 top : string","title":"top"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/","text":"Interface: MonacoEditorProps # Renderer . Component .MonacoEditorProps Table of contents # Properties # autoFocus className id innerRef language options readOnly setInitialHeight style theme value Methods # onChange onDidContentSizeChange onDidLayoutChange onError onModelChange Properties # autoFocus # \u2022 Optional autoFocus : boolean className # \u2022 Optional className : string id # \u2022 Optional id : string innerRef # \u2022 Optional innerRef : ForwardedRef < MonacoEditorRef > language # \u2022 Optional language : \"yaml\" | \"json\" options # \u2022 Optional options : Partial < IStandaloneEditorConstructionOptions > readOnly # \u2022 Optional readOnly : boolean setInitialHeight # \u2022 Optional setInitialHeight : boolean style # \u2022 Optional style : CSSProperties theme # \u2022 Optional theme : MonacoTheme value # \u2022 value : string Methods # onChange # \u25b8 Optional onChange ( value , evt ): void Parameters # Name Type value string evt IModelContentChangedEvent Returns # void onDidContentSizeChange # \u25b8 Optional onDidContentSizeChange ( evt ): void Parameters # Name Type evt IContentSizeChangedEvent Returns # void onDidLayoutChange # \u25b8 Optional onDidLayoutChange ( info ): void Parameters # Name Type info EditorLayoutInfo Returns # void onError # \u25b8 Optional onError ( error ): void Parameters # Name Type error unknown Returns # void onModelChange # \u25b8 Optional onModelChange ( model , prev? ): void Parameters # Name Type model ITextModel prev? ITextModel Returns # void","title":"Interface: MonacoEditorProps"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#interface-monacoeditorprops","text":"Renderer . Component .MonacoEditorProps","title":"Interface: MonacoEditorProps"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#properties","text":"autoFocus className id innerRef language options readOnly setInitialHeight style theme value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#methods","text":"onChange onDidContentSizeChange onDidLayoutChange onError onModelChange","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#innerref","text":"\u2022 Optional innerRef : ForwardedRef < MonacoEditorRef >","title":"innerRef"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#language","text":"\u2022 Optional language : \"yaml\" | \"json\"","title":"language"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#options","text":"\u2022 Optional options : Partial < IStandaloneEditorConstructionOptions >","title":"options"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#readonly","text":"\u2022 Optional readOnly : boolean","title":"readOnly"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#setinitialheight","text":"\u2022 Optional setInitialHeight : boolean","title":"setInitialHeight"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#theme","text":"\u2022 Optional theme : MonacoTheme","title":"theme"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#value","text":"\u2022 value : string","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#onchange","text":"\u25b8 Optional onChange ( value , evt ): void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#ondidcontentsizechange","text":"\u25b8 Optional onDidContentSizeChange ( evt ): void","title":"onDidContentSizeChange"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#ondidlayoutchange","text":"\u25b8 Optional onDidLayoutChange ( info ): void","title":"onDidLayoutChange"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#onerror","text":"\u25b8 Optional onError ( error ): void","title":"onError"},{"location":"extensions/api/interfaces/Renderer.Component.MonacoEditorProps/#onmodelchange","text":"\u25b8 Optional onModelChange ( model , prev? ): void","title":"onModelChange"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/","text":"Interface: NamespaceSelectProps # Renderer . Component .NamespaceSelectProps Type parameters # Name Type IsMulti extends boolean Hierarchy # Omit < SelectProps < string , { label : string ; value : string }, IsMulti >, \"options\" | \"value\" > \u21b3 NamespaceSelectProps Table of contents # Properties # autoConvertOptions id isCreatable menuClass showIcons sort themeName value Properties # autoConvertOptions # \u2022 Optional autoConvertOptions : boolean Deprecated We will always auto convert options if they are of type string Inherited from # Omit.autoConvertOptions id # \u2022 Optional id : string Inherited from # Omit.id isCreatable # \u2022 Optional isCreatable : boolean Deprecated This option does nothing Inherited from # Omit.isCreatable menuClass # \u2022 Optional menuClass : string Inherited from # Omit.menuClass showIcons # \u2022 Optional showIcons : boolean sort # \u2022 Optional sort : NamespaceSelectSort themeName # \u2022 Optional themeName : \"dark\" | \"light\" | \"outlined\" | \"lens\" Inherited from # Omit.themeName value # \u2022 value : undefined | null | string","title":"Interface: NamespaceSelectProps"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#interface-namespaceselectpropsismulti","text":"Renderer . Component .NamespaceSelectProps","title":"Interface: NamespaceSelectProps<IsMulti>"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#type-parameters","text":"Name Type IsMulti extends boolean","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#hierarchy","text":"Omit < SelectProps < string , { label : string ; value : string }, IsMulti >, \"options\" | \"value\" > \u21b3 NamespaceSelectProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#properties","text":"autoConvertOptions id isCreatable menuClass showIcons sort themeName value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#autoconvertoptions","text":"\u2022 Optional autoConvertOptions : boolean Deprecated We will always auto convert options if they are of type string","title":"autoConvertOptions"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#iscreatable","text":"\u2022 Optional isCreatable : boolean Deprecated This option does nothing","title":"isCreatable"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#menuclass","text":"\u2022 Optional menuClass : string","title":"menuClass"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#showicons","text":"\u2022 Optional showIcons : boolean","title":"showIcons"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#sort","text":"\u2022 Optional sort : NamespaceSelectSort","title":"sort"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#themename","text":"\u2022 Optional themeName : \"dark\" | \"light\" | \"outlined\" | \"lens\"","title":"themeName"},{"location":"extensions/api/interfaces/Renderer.Component.NamespaceSelectProps/#value","text":"\u2022 value : undefined | null | string","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/","text":"Interface: Notification # Renderer . Component .Notification Table of contents # Properties # id message status timeout Methods # onClose Properties # id # \u2022 Optional id : NotificationId message # \u2022 message : NotificationMessage status # \u2022 Optional status : NotificationStatus timeout # \u2022 Optional timeout : number Methods # onClose # \u25b8 Optional onClose (): void Returns # void","title":"Interface: Notification"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#interface-notification","text":"Renderer . Component .Notification","title":"Interface: Notification"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#properties","text":"id message status timeout","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#methods","text":"onClose","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#id","text":"\u2022 Optional id : NotificationId","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#message","text":"\u2022 message : NotificationMessage","title":"message"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#status","text":"\u2022 Optional status : NotificationStatus","title":"status"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#timeout","text":"\u2022 Optional timeout : number","title":"timeout"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.Notification/#onclose","text":"\u25b8 Optional onClose (): void","title":"onClose"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/","text":"Interface: PieChartData # Renderer . Component .PieChartData Hierarchy # ChartData \u21b3 PieChartData Table of contents # Properties # datasets Properties # datasets # \u2022 Optional datasets : PieChartDataSets [] Overrides # ChartJS.ChartData.datasets","title":"Interface: PieChartData"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#interface-piechartdata","text":"Renderer . Component .PieChartData","title":"Interface: PieChartData"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#hierarchy","text":"ChartData \u21b3 PieChartData","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#properties","text":"datasets","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartData/#datasets","text":"\u2022 Optional datasets : PieChartDataSets []","title":"datasets"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/","text":"Interface: PieChartProps # Renderer . Component .PieChartProps Hierarchy # ChartProps \u21b3 PieChartProps Table of contents # Properties # className data data-testid height legendColors legendPosition options plugins redraw showChart showLegend title type width Properties # className # \u2022 Optional className : string Inherited from # ChartProps.className data # \u2022 data : ChartData Inherited from # ChartProps.data data-testid # \u2022 Optional data-testid : string Inherited from # ChartProps.data-testid height # \u2022 Optional height : string | number Inherited from # ChartProps.height legendColors # \u2022 Optional legendColors : string [] Inherited from # ChartProps.legendColors legendPosition # \u2022 Optional legendPosition : \"bottom\" Inherited from # ChartProps.legendPosition options # \u2022 Optional options : ChartOptions Inherited from # ChartProps.options plugins # \u2022 Optional plugins : PluginServiceRegistrationOptions [] Inherited from # ChartProps.plugins redraw # \u2022 Optional redraw : boolean Inherited from # ChartProps.redraw showChart # \u2022 Optional showChart : boolean Inherited from # ChartProps.showChart showLegend # \u2022 Optional showLegend : boolean Inherited from # ChartProps.showLegend title # \u2022 Optional title : string Inherited from # ChartProps.title type # \u2022 Optional type : ChartKind Inherited from # ChartProps.type width # \u2022 Optional width : string | number Inherited from # ChartProps.width","title":"Interface: PieChartProps"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#interface-piechartprops","text":"Renderer . Component .PieChartProps","title":"Interface: PieChartProps"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#hierarchy","text":"ChartProps \u21b3 PieChartProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#properties","text":"className data data-testid height legendColors legendPosition options plugins redraw showChart showLegend title type width","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#data","text":"\u2022 data : ChartData","title":"data"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#data-testid","text":"\u2022 Optional data-testid : string","title":"data-testid"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#height","text":"\u2022 Optional height : string | number","title":"height"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#legendcolors","text":"\u2022 Optional legendColors : string []","title":"legendColors"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#legendposition","text":"\u2022 Optional legendPosition : \"bottom\"","title":"legendPosition"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#options","text":"\u2022 Optional options : ChartOptions","title":"options"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#plugins","text":"\u2022 Optional plugins : PluginServiceRegistrationOptions []","title":"plugins"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#redraw","text":"\u2022 Optional redraw : boolean","title":"redraw"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#showchart","text":"\u2022 Optional showChart : boolean","title":"showChart"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#showlegend","text":"\u2022 Optional showLegend : boolean","title":"showLegend"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#type","text":"\u2022 Optional type : ChartKind","title":"type"},{"location":"extensions/api/interfaces/Renderer.Component.PieChartProps/#width","text":"\u2022 Optional width : string | number","title":"width"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/","text":"Interface: PodDetailsListProps # Renderer . Component .PodDetailsListProps Table of contents # Properties # maxCpu maxMemory owner pods Properties # maxCpu # \u2022 Optional maxCpu : number maxMemory # \u2022 Optional maxMemory : number owner # \u2022 owner : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > pods # \u2022 pods : Pod []","title":"Interface: PodDetailsListProps"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#interface-poddetailslistprops","text":"Renderer . Component .PodDetailsListProps","title":"Interface: PodDetailsListProps"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#properties","text":"maxCpu maxMemory owner pods","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#maxcpu","text":"\u2022 Optional maxCpu : number","title":"maxCpu"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#maxmemory","text":"\u2022 Optional maxMemory : number","title":"maxMemory"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#owner","text":"\u2022 owner : KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >","title":"owner"},{"location":"extensions/api/interfaces/Renderer.Component.PodDetailsListProps/#pods","text":"\u2022 pods : Pod []","title":"pods"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/","text":"Interface: RadioGroupProps # Renderer . Component .RadioGroupProps Type parameters # Name T Table of contents # Properties # asButtons children className disabled onChange value Properties # asButtons # \u2022 Optional asButtons : boolean children # \u2022 children : SingleOrMany < ReactElement < RadioProps < T >, string | JSXElementConstructor < any >>> className # \u2022 Optional className : string disabled # \u2022 Optional disabled : boolean onChange # \u2022 onChange : ( value : T ) => void Type declaration # \u25b8 ( value ): void Parameters # Name Type value T Returns # void value # \u2022 Optional value : T","title":"Interface: RadioGroupProps"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#interface-radiogrouppropst","text":"Renderer . Component .RadioGroupProps","title":"Interface: RadioGroupProps<T>"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#type-parameters","text":"Name T","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#properties","text":"asButtons children className disabled onChange value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#asbuttons","text":"\u2022 Optional asButtons : boolean","title":"asButtons"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#children","text":"\u2022 children : SingleOrMany < ReactElement < RadioProps < T >, string | JSXElementConstructor < any >>>","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#onchange","text":"\u2022 onChange : ( value : T ) => void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.RadioGroupProps/#value","text":"\u2022 Optional value : T","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/","text":"Interface: RadioProps # Renderer . Component .RadioProps Type parameters # Name T Table of contents # Properties # className disabled label value Properties # className # \u2022 Optional className : string disabled # \u2022 Optional disabled : boolean label # \u2022 label : ReactNode value # \u2022 value : T","title":"Interface: RadioProps"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#interface-radiopropst","text":"Renderer . Component .RadioProps","title":"Interface: RadioProps<T>"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#type-parameters","text":"Name T","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#properties","text":"className disabled label value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#label","text":"\u2022 label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/Renderer.Component.RadioProps/#value","text":"\u2022 value : T","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/","text":"Interface: SearchInputProps # Renderer . Component .SearchInputProps Hierarchy # InputProps \u21b3 SearchInputProps Table of contents # Properties # autoSelectOnFocus bindGlobalFocusHotkey blurOnEnter compact contentRight dirty iconLeft iconRight maxRows multiLine showClearIcon showErrorsAsTooltip showValidationLine theme trim validators Methods # onChange onClear onSubmit Properties # autoSelectOnFocus # \u2022 Optional autoSelectOnFocus : boolean Inherited from # InputProps.autoSelectOnFocus bindGlobalFocusHotkey # \u2022 Optional bindGlobalFocusHotkey : boolean blurOnEnter # \u2022 Optional blurOnEnter : boolean Inherited from # InputProps.blurOnEnter compact # \u2022 Optional compact : boolean contentRight # \u2022 Optional contentRight : ReactNode Inherited from # InputProps.contentRight dirty # \u2022 Optional dirty : boolean Inherited from # InputProps.dirty iconLeft # \u2022 Optional iconLeft : IconData Inherited from # InputProps.iconLeft iconRight # \u2022 Optional iconRight : IconData Inherited from # InputProps.iconRight maxRows # \u2022 Optional maxRows : number Inherited from # InputProps.maxRows multiLine # \u2022 Optional multiLine : boolean Inherited from # InputProps.multiLine showClearIcon # \u2022 Optional showClearIcon : boolean showErrorsAsTooltip # \u2022 Optional showErrorsAsTooltip : boolean | Omit < TooltipProps , \"targetId\" > Inherited from # InputProps.showErrorsAsTooltip showValidationLine # \u2022 Optional showValidationLine : boolean Inherited from # InputProps.showValidationLine theme # \u2022 Optional theme : \"round-black\" | \"round\" Inherited from # InputProps.theme trim # \u2022 Optional trim : boolean Inherited from # InputProps.trim validators # \u2022 Optional validators : SingleOrMany < InputValidator < boolean >> Inherited from # InputProps.validators Methods # onChange # \u25b8 Optional onChange ( value , evt ): void Parameters # Name Type value string evt ChangeEvent < InputElement > Returns # void Inherited from # InputProps.onChange onClear # \u25b8 Optional onClear (): void Returns # void onSubmit # \u25b8 Optional onSubmit ( value , evt ): void Parameters # Name Type value string evt KeyboardEvent < InputElement > Returns # void Inherited from # InputProps.onSubmit","title":"Interface: SearchInputProps"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#interface-searchinputprops","text":"Renderer . Component .SearchInputProps","title":"Interface: SearchInputProps"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#hierarchy","text":"InputProps \u21b3 SearchInputProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#properties","text":"autoSelectOnFocus bindGlobalFocusHotkey blurOnEnter compact contentRight dirty iconLeft iconRight maxRows multiLine showClearIcon showErrorsAsTooltip showValidationLine theme trim validators","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#methods","text":"onChange onClear onSubmit","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#autoselectonfocus","text":"\u2022 Optional autoSelectOnFocus : boolean","title":"autoSelectOnFocus"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#bindglobalfocushotkey","text":"\u2022 Optional bindGlobalFocusHotkey : boolean","title":"bindGlobalFocusHotkey"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#bluronenter","text":"\u2022 Optional blurOnEnter : boolean","title":"blurOnEnter"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#compact","text":"\u2022 Optional compact : boolean","title":"compact"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#contentright","text":"\u2022 Optional contentRight : ReactNode","title":"contentRight"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#dirty","text":"\u2022 Optional dirty : boolean","title":"dirty"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#iconleft","text":"\u2022 Optional iconLeft : IconData","title":"iconLeft"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#iconright","text":"\u2022 Optional iconRight : IconData","title":"iconRight"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#maxrows","text":"\u2022 Optional maxRows : number","title":"maxRows"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#multiline","text":"\u2022 Optional multiLine : boolean","title":"multiLine"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#showclearicon","text":"\u2022 Optional showClearIcon : boolean","title":"showClearIcon"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#showerrorsastooltip","text":"\u2022 Optional showErrorsAsTooltip : boolean | Omit < TooltipProps , \"targetId\" >","title":"showErrorsAsTooltip"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#showvalidationline","text":"\u2022 Optional showValidationLine : boolean","title":"showValidationLine"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#theme","text":"\u2022 Optional theme : \"round-black\" | \"round\"","title":"theme"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#trim","text":"\u2022 Optional trim : boolean","title":"trim"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#validators","text":"\u2022 Optional validators : SingleOrMany < InputValidator < boolean >>","title":"validators"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#onchange","text":"\u25b8 Optional onChange ( value , evt ): void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#onclear","text":"\u25b8 Optional onClear (): void","title":"onClear"},{"location":"extensions/api/interfaces/Renderer.Component.SearchInputProps/#onsubmit","text":"\u25b8 Optional onSubmit ( value , evt ): void","title":"onSubmit"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/","text":"Interface: SelectOption # Renderer . Component .SelectOption Type parameters # Name Value Table of contents # Properties # id isDisabled isSelected label value Properties # id # \u2022 Optional id : string isDisabled # \u2022 Optional isDisabled : boolean isSelected # \u2022 Optional isSelected : boolean label # \u2022 label : ReactNode value # \u2022 value : Value","title":"Interface: SelectOption"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#interface-selectoptionvalue","text":"Renderer . Component .SelectOption","title":"Interface: SelectOption<Value>"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#type-parameters","text":"Name Value","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#properties","text":"id isDisabled isSelected label value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#isdisabled","text":"\u2022 Optional isDisabled : boolean","title":"isDisabled"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#isselected","text":"\u2022 Optional isSelected : boolean","title":"isSelected"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#label","text":"\u2022 label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/Renderer.Component.SelectOption/#value","text":"\u2022 value : Value","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/","text":"Interface: SelectProps # Renderer . Component .SelectProps Type parameters # Name Type Value Value Option extends SelectOption < Value > IsMulti extends boolean Group extends GroupBase < Option > = GroupBase < Option > Hierarchy # Omit < ReactSelectProps < Option , IsMulti , Group >, \"value\" | \"options\" > \u21b3 SelectProps Table of contents # Properties # autoConvertOptions id isCreatable menuClass options themeName value Properties # autoConvertOptions # \u2022 Optional autoConvertOptions : boolean Deprecated We will always auto convert options if they are of type string id # \u2022 Optional id : string Overrides # Omit.id isCreatable # \u2022 Optional isCreatable : boolean Deprecated This option does nothing menuClass # \u2022 Optional menuClass : string options # \u2022 options : OptionsOrGroups < Option , Group > | LegacyAutoConvertedOptions themeName # \u2022 Optional themeName : \"dark\" | \"light\" | \"outlined\" | \"lens\" value # \u2022 Optional value : PropsValue < Value >","title":"Interface: SelectProps"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#interface-selectpropsvalue-option-ismulti-group","text":"Renderer . Component .SelectProps","title":"Interface: SelectProps<Value, Option, IsMulti, Group>"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#type-parameters","text":"Name Type Value Value Option extends SelectOption < Value > IsMulti extends boolean Group extends GroupBase < Option > = GroupBase < Option >","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#hierarchy","text":"Omit < ReactSelectProps < Option , IsMulti , Group >, \"value\" | \"options\" > \u21b3 SelectProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#properties","text":"autoConvertOptions id isCreatable menuClass options themeName value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#autoconvertoptions","text":"\u2022 Optional autoConvertOptions : boolean Deprecated We will always auto convert options if they are of type string","title":"autoConvertOptions"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#iscreatable","text":"\u2022 Optional isCreatable : boolean Deprecated This option does nothing","title":"isCreatable"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#menuclass","text":"\u2022 Optional menuClass : string","title":"menuClass"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#options","text":"\u2022 options : OptionsOrGroups < Option , Group > | LegacyAutoConvertedOptions","title":"options"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#themename","text":"\u2022 Optional themeName : \"dark\" | \"light\" | \"outlined\" | \"lens\"","title":"themeName"},{"location":"extensions/api/interfaces/Renderer.Component.SelectProps/#value","text":"\u2022 Optional value : PropsValue < Value >","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/","text":"Interface: SettingLayoutProps # Renderer . Component .SettingLayoutProps Hierarchy # DOMAttributes < any > \u21b3 SettingLayoutProps Table of contents # Properties # back className closeButtonProps contentClass contentGaps navigation provideBackButtonNavigation Properties # back # \u2022 Optional back : ( evt : MouseEvent < Element , MouseEvent > | KeyboardEvent ) => void Type declaration # \u25b8 ( evt ): void Parameters # Name Type evt MouseEvent < Element , MouseEvent > | KeyboardEvent Returns # void className # \u2022 Optional className : IClassName closeButtonProps # \u2022 Optional closeButtonProps : Object Type declaration # Name Type data-testid? string contentClass # \u2022 Optional contentClass : IClassName contentGaps # \u2022 Optional contentGaps : boolean navigation # \u2022 Optional navigation : ReactNode provideBackButtonNavigation # \u2022 Optional provideBackButtonNavigation : boolean","title":"Interface: SettingLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#interface-settinglayoutprops","text":"Renderer . Component .SettingLayoutProps","title":"Interface: SettingLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#hierarchy","text":"DOMAttributes < any > \u21b3 SettingLayoutProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#properties","text":"back className closeButtonProps contentClass contentGaps navigation provideBackButtonNavigation","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#back","text":"\u2022 Optional back : ( evt : MouseEvent < Element , MouseEvent > | KeyboardEvent ) => void","title":"back"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#classname","text":"\u2022 Optional className : IClassName","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#closebuttonprops","text":"\u2022 Optional closeButtonProps : Object","title":"closeButtonProps"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#contentclass","text":"\u2022 Optional contentClass : IClassName","title":"contentClass"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#contentgaps","text":"\u2022 Optional contentGaps : boolean","title":"contentGaps"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#navigation","text":"\u2022 Optional navigation : ReactNode","title":"navigation"},{"location":"extensions/api/interfaces/Renderer.Component.SettingLayoutProps/#providebackbuttonnavigation","text":"\u2022 Optional provideBackButtonNavigation : boolean","title":"provideBackButtonNavigation"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/","text":"Interface: SliderProps # Renderer . Component .SliderProps Hierarchy # Omit < MaterialSliderProps , \"onChange\" > \u21b3 SliderProps Table of contents # Properties # className Methods # onChange Properties # className # \u2022 Optional className : string Overrides # Omit.className Methods # onChange # \u25b8 onChange ( evt , value ): void Parameters # Name Type evt FormEvent < any > value number Returns # void","title":"Interface: SliderProps"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#interface-sliderprops","text":"Renderer . Component .SliderProps","title":"Interface: SliderProps"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#hierarchy","text":"Omit < MaterialSliderProps , \"onChange\" > \u21b3 SliderProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#properties","text":"className","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#methods","text":"onChange","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.SliderProps/#onchange","text":"\u25b8 onChange ( evt , value ): void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/","text":"Interface: SpinnerProps # Renderer . Component .SpinnerProps Hierarchy # HTMLProps < any > \u21b3 SpinnerProps Table of contents # Properties # center singleColor Properties # center # \u2022 Optional center : boolean singleColor # \u2022 Optional singleColor : boolean","title":"Interface: SpinnerProps"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#interface-spinnerprops","text":"Renderer . Component .SpinnerProps","title":"Interface: SpinnerProps"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#hierarchy","text":"HTMLProps < any > \u21b3 SpinnerProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#properties","text":"center singleColor","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#center","text":"\u2022 Optional center : boolean","title":"center"},{"location":"extensions/api/interfaces/Renderer.Component.SpinnerProps/#singlecolor","text":"\u2022 Optional singleColor : boolean","title":"singleColor"},{"location":"extensions/api/interfaces/Renderer.Component.StatusBrickProps/","text":"Interface: StatusBrickProps # Renderer . Component .StatusBrickProps Hierarchy # HTMLAttributes < HTMLDivElement > \u21b3 StatusBrickProps","title":"Interface: StatusBrickProps"},{"location":"extensions/api/interfaces/Renderer.Component.StatusBrickProps/#interface-statusbrickprops","text":"Renderer . Component .StatusBrickProps","title":"Interface: StatusBrickProps"},{"location":"extensions/api/interfaces/Renderer.Component.StatusBrickProps/#hierarchy","text":"HTMLAttributes < HTMLDivElement > \u21b3 StatusBrickProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/","text":"Interface: StepperProps # Renderer . Component .StepperProps Hierarchy # HTMLProps < any > \u21b3 StepperProps Table of contents # Properties # step steps Properties # step # \u2022 step : number Overrides # React.HTMLProps.step steps # \u2022 steps : Step []","title":"Interface: StepperProps"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#interface-stepperprops","text":"Renderer . Component .StepperProps","title":"Interface: StepperProps"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#hierarchy","text":"HTMLProps < any > \u21b3 StepperProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#properties","text":"step steps","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#step","text":"\u2022 step : number","title":"step"},{"location":"extensions/api/interfaces/Renderer.Component.StepperProps/#steps","text":"\u2022 steps : Step []","title":"steps"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/","text":"Interface: SubTitleProps # Renderer . Component .SubTitleProps Table of contents # Properties # children className compact id title Properties # children # \u2022 Optional children : SingleOrMany < ReactNode > className # \u2022 Optional className : string compact # \u2022 Optional compact : boolean id # \u2022 Optional id : string title # \u2022 title : ReactNode","title":"Interface: SubTitleProps"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#interface-subtitleprops","text":"Renderer . Component .SubTitleProps","title":"Interface: SubTitleProps"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#properties","text":"children className compact id title","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#children","text":"\u2022 Optional children : SingleOrMany < ReactNode >","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#compact","text":"\u2022 Optional compact : boolean","title":"compact"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.SubTitleProps/#title","text":"\u2022 title : ReactNode","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/","text":"Interface: SwitchProps # Renderer . Component .SwitchProps Hierarchy # Omit < HTMLProps < HTMLInputElement >, \"onChange\" > \u21b3 SwitchProps Table of contents # Properties # onChange Properties # onChange # \u2022 Optional onChange : ( checked : boolean , event : ChangeEvent < HTMLInputElement >) => void Type declaration # \u25b8 ( checked , event ): void Parameters # Name Type checked boolean event ChangeEvent < HTMLInputElement > Returns # void","title":"Interface: SwitchProps"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#interface-switchprops","text":"Renderer . Component .SwitchProps","title":"Interface: SwitchProps"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#hierarchy","text":"Omit < HTMLProps < HTMLInputElement >, \"onChange\" > \u21b3 SwitchProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#properties","text":"onChange","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SwitchProps/#onchange","text":"\u2022 Optional onChange : ( checked : boolean , event : ChangeEvent < HTMLInputElement >) => void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/","text":"Interface: SwitcherProps # Renderer . Component .SwitcherProps Table of contents # Properties # checked children disabled name onChange Properties # checked # \u2022 Optional checked : boolean children # \u2022 Optional children : ReactNode disabled # \u2022 Optional disabled : boolean name # \u2022 Optional name : string onChange # \u2022 Optional onChange : ( event : ChangeEvent < HTMLInputElement >, checked : boolean ) => void Type declaration # \u25b8 ( event , checked ): void Parameters # Name Type event ChangeEvent < HTMLInputElement > checked boolean Returns # void","title":"Interface: SwitcherProps"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#interface-switcherprops","text":"Renderer . Component .SwitcherProps","title":"Interface: SwitcherProps"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#properties","text":"checked children disabled name onChange","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#checked","text":"\u2022 Optional checked : boolean","title":"checked"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#name","text":"\u2022 Optional name : string","title":"name"},{"location":"extensions/api/interfaces/Renderer.Component.SwitcherProps/#onchange","text":"\u2022 Optional onChange : ( event : ChangeEvent < HTMLInputElement >, checked : boolean ) => void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/","text":"Interface: TabLayoutProps # Renderer . Component .TabLayoutProps Table of contents # Properties # children className contentClass scrollable tabs Properties # children # \u2022 Optional children : ReactNode className # \u2022 Optional className : IClassName contentClass # \u2022 Optional contentClass : IClassName scrollable # \u2022 Optional scrollable : boolean tabs # \u2022 Optional tabs : TabLayoutRoute []","title":"Interface: TabLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#interface-tablayoutprops","text":"Renderer . Component .TabLayoutProps","title":"Interface: TabLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#properties","text":"children className contentClass scrollable tabs","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#classname","text":"\u2022 Optional className : IClassName","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#contentclass","text":"\u2022 Optional contentClass : IClassName","title":"contentClass"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#scrollable","text":"\u2022 Optional scrollable : boolean","title":"scrollable"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutProps/#tabs","text":"\u2022 Optional tabs : TabLayoutRoute []","title":"tabs"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/","text":"Interface: TabLayoutRoute # Renderer . Component .TabLayoutRoute Table of contents # Properties # component default exact routePath title url Properties # component # \u2022 component : ComponentType < any > default # \u2022 Optional default : boolean exact # \u2022 Optional exact : boolean routePath # \u2022 routePath : string title # \u2022 title : ReactNode url # \u2022 Optional url : string","title":"Interface: TabLayoutRoute"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#interface-tablayoutroute","text":"Renderer . Component .TabLayoutRoute","title":"Interface: TabLayoutRoute"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#properties","text":"component default exact routePath title url","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#component","text":"\u2022 component : ComponentType < any >","title":"component"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#default","text":"\u2022 Optional default : boolean","title":"default"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#exact","text":"\u2022 Optional exact : boolean","title":"exact"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#routepath","text":"\u2022 routePath : string","title":"routePath"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#title","text":"\u2022 title : ReactNode","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.TabLayoutRoute/#url","text":"\u2022 Optional url : string","title":"url"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/","text":"Interface: TabProps # Renderer . Component .TabProps Type parameters # Name D Hierarchy # DOMAttributes < HTMLElement > \u21b3 TabProps Table of contents # Properties # active className disabled icon id label value Properties # active # \u2022 Optional active : boolean className # \u2022 Optional className : string disabled # \u2022 Optional disabled : boolean icon # \u2022 Optional icon : ReactNode id # \u2022 Optional id : string label # \u2022 Optional label : ReactNode value # \u2022 value : D","title":"Interface: TabProps"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#interface-tabpropsd","text":"Renderer . Component .TabProps","title":"Interface: TabProps<D>"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#hierarchy","text":"DOMAttributes < HTMLElement > \u21b3 TabProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#properties","text":"active className disabled icon id label value","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#active","text":"\u2022 Optional active : boolean","title":"active"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#icon","text":"\u2022 Optional icon : ReactNode","title":"icon"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#label","text":"\u2022 Optional label : ReactNode","title":"label"},{"location":"extensions/api/interfaces/Renderer.Component.TabProps/#value","text":"\u2022 value : D","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/","text":"Interface: TableCellProps # Renderer . Component .TableCellProps Hierarchy # DOMAttributes < HTMLDivElement > \u21b3 TableCellProps Table of contents # Properties # _nowrap _sorting checkbox className id isChecked scrollable showWithColumn sortBy title Methods # _sort Properties # _nowrap # \u2022 Optional _nowrap : boolean indicator, might come from parent , don't use this prop outside (!) _sorting # \u2022 Optional _sorting : Partial < TableSortParams > checkbox # \u2022 Optional checkbox : boolean render cell with a checkbox className # \u2022 Optional className : string Any css class names for this table cell. Only used if title is a \"simple\" react node id # \u2022 Optional id : string used for configuration visibility of columns isChecked # \u2022 Optional isChecked : boolean mark checkbox as checked or not scrollable # \u2022 Optional scrollable : boolean content inside could be scrolled showWithColumn # \u2022 Optional showWithColumn : string id of the column which follow same visibility rules sortBy # \u2022 Optional sortBy : string column name, must be same as key in sortable object title # \u2022 Optional title : ReactNode The actual value of the cell Methods # _sort # \u25b8 Optional _sort ( sortBy ): void Parameters # Name Type sortBy string Returns # void","title":"Interface: TableCellProps"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#interface-tablecellprops","text":"Renderer . Component .TableCellProps","title":"Interface: TableCellProps"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#hierarchy","text":"DOMAttributes < HTMLDivElement > \u21b3 TableCellProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#properties","text":"_nowrap _sorting checkbox className id isChecked scrollable showWithColumn sortBy title","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#methods","text":"_sort","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#_nowrap","text":"\u2022 Optional _nowrap : boolean indicator, might come from parent , don't use this prop outside (!)","title":"_nowrap"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#_sorting","text":"\u2022 Optional _sorting : Partial < TableSortParams >","title":"_sorting"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#checkbox","text":"\u2022 Optional checkbox : boolean render cell with a checkbox","title":"checkbox"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#classname","text":"\u2022 Optional className : string Any css class names for this table cell. Only used if title is a \"simple\" react node","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#id","text":"\u2022 Optional id : string used for configuration visibility of columns","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#ischecked","text":"\u2022 Optional isChecked : boolean mark checkbox as checked or not","title":"isChecked"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#scrollable","text":"\u2022 Optional scrollable : boolean content inside could be scrolled","title":"scrollable"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#showwithcolumn","text":"\u2022 Optional showWithColumn : string id of the column which follow same visibility rules","title":"showWithColumn"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#sortby","text":"\u2022 Optional sortBy : string column name, must be same as key in sortable object","title":"sortBy"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#title","text":"\u2022 Optional title : ReactNode The actual value of the cell","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.TableCellProps/#_sort","text":"\u25b8 Optional _sort ( sortBy ): void","title":"_sort"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/","text":"Interface: TableHeadProps # Renderer . Component .TableHeadProps Hierarchy # DOMAttributes < HTMLDivElement > \u21b3 TableHeadProps Table of contents # Properties # className flat nowrap showTopLine sticky Properties # className # \u2022 Optional className : string flat # \u2022 Optional flat : boolean nowrap # \u2022 Optional nowrap : boolean showTopLine # \u2022 Optional showTopLine : boolean sticky # \u2022 Optional sticky : boolean","title":"Interface: TableHeadProps"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#interface-tableheadprops","text":"Renderer . Component .TableHeadProps","title":"Interface: TableHeadProps"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#hierarchy","text":"DOMAttributes < HTMLDivElement > \u21b3 TableHeadProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#properties","text":"className flat nowrap showTopLine sticky","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#flat","text":"\u2022 Optional flat : boolean","title":"flat"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#nowrap","text":"\u2022 Optional nowrap : boolean","title":"nowrap"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#showtopline","text":"\u2022 Optional showTopLine : boolean","title":"showTopLine"},{"location":"extensions/api/interfaces/Renderer.Component.TableHeadProps/#sticky","text":"\u2022 Optional sticky : boolean","title":"sticky"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/","text":"Interface: TableProps # Renderer . Component .TableProps Type parameters # Name Item Hierarchy # DOMAttributes < HTMLDivElement > \u21b3 TableProps Table of contents # Properties # autoSize className customRowHeights getTableRow items noItems onSort renderRow rowLineHeight rowPadding scrollable selectable selectedItemId sortByDefault sortSyncWithUrl sortable storageKey tableId virtual virtualHeight Properties # autoSize # \u2022 Optional autoSize : boolean className # \u2022 Optional className : string customRowHeights # \u2022 Optional customRowHeights : ( item : Item , lineHeight : number , paddings : number ) => number Type declaration # \u25b8 ( item , lineHeight , paddings ): number Parameters # Name Type item Item lineHeight number paddings number Returns # number getTableRow # \u2022 Optional getTableRow : ( uid : string ) => undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >> Type declaration # \u25b8 ( uid ): undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >> Parameters # Name Type uid string Returns # undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >> items # \u2022 Optional items : Item [] noItems # \u2022 Optional noItems : ReactNode onSort # \u2022 Optional onSort : ( params : TableSortParams ) => void Type declaration # \u25b8 ( params ): void Parameters # Name Type params TableSortParams Returns # void renderRow # \u2022 Optional renderRow : ( item : Item ) => undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >> Type declaration # \u25b8 ( item ): undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >> Parameters # Name Type item Item Returns # undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >> rowLineHeight # \u2022 Optional rowLineHeight : number Row line height in pixels rowPadding # \u2022 Optional rowPadding : number Row padding in pixels scrollable # \u2022 Optional scrollable : boolean selectable # \u2022 Optional selectable : boolean selectedItemId # \u2022 Optional selectedItemId : string sortByDefault # \u2022 Optional sortByDefault : Partial < TableSortParams > sortSyncWithUrl # \u2022 Optional sortSyncWithUrl : boolean sortable # \u2022 Optional sortable : TableSortCallbacks < Item > Define sortable callbacks for every column in Sort Item argument in the callback is an object, provided in storageKey # \u2022 Optional storageKey : string tableId # \u2022 Optional tableId : string virtual # \u2022 Optional virtual : boolean Use virtual list component to render only visible rows. By default uses a auto sizer to fill available height virtualHeight # \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 ,","title":"Interface: TableProps"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#interface-tablepropsitem","text":"Renderer . Component .TableProps","title":"Interface: TableProps<Item>"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#type-parameters","text":"Name Item","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#hierarchy","text":"DOMAttributes < HTMLDivElement > \u21b3 TableProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#properties","text":"autoSize className customRowHeights getTableRow items noItems onSort renderRow rowLineHeight rowPadding scrollable selectable selectedItemId sortByDefault sortSyncWithUrl sortable storageKey tableId virtual virtualHeight","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#autosize","text":"\u2022 Optional autoSize : boolean","title":"autoSize"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#customrowheights","text":"\u2022 Optional customRowHeights : ( item : Item , lineHeight : number , paddings : number ) => number","title":"customRowHeights"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#gettablerow","text":"\u2022 Optional getTableRow : ( uid : string ) => undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >>","title":"getTableRow"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#items","text":"\u2022 Optional items : Item []","title":"items"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#noitems","text":"\u2022 Optional noItems : ReactNode","title":"noItems"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#onsort","text":"\u2022 Optional onSort : ( params : TableSortParams ) => void","title":"onSort"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#renderrow","text":"\u2022 Optional renderRow : ( item : Item ) => undefined | null | ReactElement < TableRowProps < Item >, string | JSXElementConstructor < any >>","title":"renderRow"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#rowlineheight","text":"\u2022 Optional rowLineHeight : number Row line height in pixels","title":"rowLineHeight"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#rowpadding","text":"\u2022 Optional rowPadding : number Row padding in pixels","title":"rowPadding"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#scrollable","text":"\u2022 Optional scrollable : boolean","title":"scrollable"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#selectable","text":"\u2022 Optional selectable : boolean","title":"selectable"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#selecteditemid","text":"\u2022 Optional selectedItemId : string","title":"selectedItemId"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#sortbydefault","text":"\u2022 Optional sortByDefault : Partial < TableSortParams >","title":"sortByDefault"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#sortsyncwithurl","text":"\u2022 Optional sortSyncWithUrl : boolean","title":"sortSyncWithUrl"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#sortable","text":"\u2022 Optional sortable : TableSortCallbacks < Item > Define sortable callbacks for every column in Sort Item argument in the callback is an object, provided in","title":"sortable"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#storagekey","text":"\u2022 Optional storageKey : string","title":"storageKey"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#tableid","text":"\u2022 Optional tableId : string","title":"tableId"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#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","title":"virtual"},{"location":"extensions/api/interfaces/Renderer.Component.TableProps/#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 ,","title":"virtualHeight"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/","text":"Interface: TableRowProps # Renderer . Component .TableRowProps Type parameters # Name Item Hierarchy # DOMAttributes < HTMLDivElement > \u21b3 TableRowProps Table of contents # Properties # className disabled nowrap searchItem selected sortItem style testId Properties # className # \u2022 Optional className : string disabled # \u2022 Optional disabled : boolean nowrap # \u2022 Optional nowrap : boolean searchItem # \u2022 Optional searchItem : Item selected # \u2022 Optional selected : boolean sortItem # \u2022 Optional sortItem : Item style # \u2022 Optional style : CSSProperties testId # \u2022 Optional testId : string","title":"Interface: TableRowProps"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#interface-tablerowpropsitem","text":"Renderer . Component .TableRowProps","title":"Interface: TableRowProps<Item>"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#type-parameters","text":"Name Item","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#hierarchy","text":"DOMAttributes < HTMLDivElement > \u21b3 TableRowProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#properties","text":"className disabled nowrap searchItem selected sortItem style testId","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#disabled","text":"\u2022 Optional disabled : boolean","title":"disabled"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#nowrap","text":"\u2022 Optional nowrap : boolean","title":"nowrap"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#searchitem","text":"\u2022 Optional searchItem : Item","title":"searchItem"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#selected","text":"\u2022 Optional selected : boolean","title":"selected"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#sortitem","text":"\u2022 Optional sortItem : Item","title":"sortItem"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/Renderer.Component.TableRowProps/#testid","text":"\u2022 Optional testId : string","title":"testId"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/","text":"Interface: TableSortParams # Renderer . Component .TableSortParams Table of contents # Properties # orderBy sortBy Properties # orderBy # \u2022 orderBy : TableOrderBy sortBy # \u2022 sortBy : string","title":"Interface: TableSortParams"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#interface-tablesortparams","text":"Renderer . Component .TableSortParams","title":"Interface: TableSortParams"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#properties","text":"orderBy sortBy","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#orderby","text":"\u2022 orderBy : TableOrderBy","title":"orderBy"},{"location":"extensions/api/interfaces/Renderer.Component.TableSortParams/#sortby","text":"\u2022 sortBy : string","title":"sortBy"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/","text":"Interface: TabsProps # Renderer . Component .TabsProps Type parameters # Name D Hierarchy # TabsContextValue < D > Omit < DOMAttributes < HTMLElement >, \"onChange\" > \u21b3 TabsProps Table of contents # Properties # autoFocus center className scrollable value withBorder wrap Methods # onChange Properties # autoFocus # \u2022 Optional autoFocus : boolean Inherited from # TabsContextValue.autoFocus center # \u2022 Optional center : boolean className # \u2022 Optional className : string scrollable # \u2022 Optional scrollable : boolean value # \u2022 Optional value : D Inherited from # TabsContextValue.value withBorder # \u2022 Optional withBorder : boolean Inherited from # TabsContextValue.withBorder wrap # \u2022 Optional wrap : boolean Methods # onChange # \u25b8 Optional onChange ( value ): void Parameters # Name Type value D Returns # void Inherited from # TabsContextValue.onChange","title":"Interface: TabsProps"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#interface-tabspropsd","text":"Renderer . Component .TabsProps","title":"Interface: TabsProps<D>"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#hierarchy","text":"TabsContextValue < D > Omit < DOMAttributes < HTMLElement >, \"onChange\" > \u21b3 TabsProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#properties","text":"autoFocus center className scrollable value withBorder wrap","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#methods","text":"onChange","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#autofocus","text":"\u2022 Optional autoFocus : boolean","title":"autoFocus"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#center","text":"\u2022 Optional center : boolean","title":"center"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#scrollable","text":"\u2022 Optional scrollable : boolean","title":"scrollable"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#value","text":"\u2022 Optional value : D","title":"value"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#withborder","text":"\u2022 Optional withBorder : boolean","title":"withBorder"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#wrap","text":"\u2022 Optional wrap : boolean","title":"wrap"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Component.TabsProps/#onchange","text":"\u25b8 Optional onChange ( value ): void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/","text":"Interface: TooltipContentFormatters # Renderer . Component .TooltipContentFormatters Table of contents # Properties # narrow nowrap small tableView warning Properties # narrow # \u2022 Optional narrow : boolean nowrap # \u2022 Optional nowrap : boolean small # \u2022 Optional small : boolean tableView # \u2022 Optional tableView : boolean warning # \u2022 Optional warning : boolean","title":"Interface: TooltipContentFormatters"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#interface-tooltipcontentformatters","text":"Renderer . Component .TooltipContentFormatters","title":"Interface: TooltipContentFormatters"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#properties","text":"narrow nowrap small tableView warning","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#narrow","text":"\u2022 Optional narrow : boolean","title":"narrow"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#nowrap","text":"\u2022 Optional nowrap : boolean","title":"nowrap"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#small","text":"\u2022 Optional small : boolean","title":"small"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#tableview","text":"\u2022 Optional tableView : boolean","title":"tableView"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipContentFormatters/#warning","text":"\u2022 Optional warning : boolean","title":"warning"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/","text":"Interface: TooltipDecoratorProps # Renderer . Component .TooltipDecoratorProps Table of contents # Properties # children id tooltip tooltipOverrideDisabled Properties # children # \u2022 Optional children : SingleOrMany < ReactNode > id # \u2022 Optional id : string tooltip # \u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" > tooltipOverrideDisabled # \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\"","title":"Interface: TooltipDecoratorProps"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#interface-tooltipdecoratorprops","text":"Renderer . Component .TooltipDecoratorProps","title":"Interface: TooltipDecoratorProps"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#properties","text":"children id tooltip tooltipOverrideDisabled","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#children","text":"\u2022 Optional children : SingleOrMany < ReactNode >","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#id","text":"\u2022 Optional id : string","title":"id"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#tooltip","text":"\u2022 Optional tooltip : ReactNode | Omit < TooltipProps , \"targetId\" >","title":"tooltip"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipDecoratorProps/#tooltipoverridedisabled","text":"\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\"","title":"tooltipOverrideDisabled"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/","text":"Interface: TooltipProps # Renderer . Component .TooltipProps Table of contents # Properties # children className formatters offset preferredPositions style targetId tooltipOnParentHover usePortal visible Properties # children # \u2022 Optional children : ReactNode className # \u2022 Optional className : IClassName formatters # \u2022 Optional formatters : TooltipContentFormatters offset # \u2022 Optional offset : number preferredPositions # \u2022 Optional preferredPositions : TooltipPosition | TooltipPosition [] style # \u2022 Optional style : CSSProperties targetId # \u2022 targetId : string tooltipOnParentHover # \u2022 Optional tooltipOnParentHover : boolean usePortal # \u2022 Optional usePortal : boolean visible # \u2022 Optional visible : boolean","title":"Interface: TooltipProps"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#interface-tooltipprops","text":"Renderer . Component .TooltipProps","title":"Interface: TooltipProps"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#properties","text":"children className formatters offset preferredPositions style targetId tooltipOnParentHover usePortal visible","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#children","text":"\u2022 Optional children : ReactNode","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#classname","text":"\u2022 Optional className : IClassName","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#formatters","text":"\u2022 Optional formatters : TooltipContentFormatters","title":"formatters"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#offset","text":"\u2022 Optional offset : number","title":"offset"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#preferredpositions","text":"\u2022 Optional preferredPositions : TooltipPosition | TooltipPosition []","title":"preferredPositions"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#style","text":"\u2022 Optional style : CSSProperties","title":"style"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#targetid","text":"\u2022 targetId : string","title":"targetId"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#tooltiponparenthover","text":"\u2022 Optional tooltipOnParentHover : boolean","title":"tooltipOnParentHover"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#useportal","text":"\u2022 Optional usePortal : boolean","title":"usePortal"},{"location":"extensions/api/interfaces/Renderer.Component.TooltipProps/#visible","text":"\u2022 Optional visible : boolean","title":"visible"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/","text":"Interface: WizardCommonProps # Renderer . Component .WizardCommonProps Type parameters # Name D Hierarchy # WizardCommonProps \u21b3 WizardProps \u21b3 WizardStepProps Table of contents # Properties # data done hideSteps reset save Properties # data # \u2022 Optional data : Partial < D > done # \u2022 Optional done : () => void Type declaration # \u25b8 (): void Returns # void hideSteps # \u2022 Optional hideSteps : boolean reset # \u2022 Optional reset : () => void Type declaration # \u25b8 (): void Returns # void save # \u2022 Optional save : ( data : Partial < D >, callback? : () => void ) => void Type declaration # \u25b8 ( data , callback? ): void Parameters # Name Type data Partial < D > callback? () => void Returns # void","title":"Interface: WizardCommonProps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#interface-wizardcommonpropsd","text":"Renderer . Component .WizardCommonProps","title":"Interface: WizardCommonProps<D>"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#hierarchy","text":"WizardCommonProps \u21b3 WizardProps \u21b3 WizardStepProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#properties","text":"data done hideSteps reset save","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#data","text":"\u2022 Optional data : Partial < D >","title":"data"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#done","text":"\u2022 Optional done : () => void","title":"done"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#hidesteps","text":"\u2022 Optional hideSteps : boolean","title":"hideSteps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#reset","text":"\u2022 Optional reset : () => void","title":"reset"},{"location":"extensions/api/interfaces/Renderer.Component.WizardCommonProps/#save","text":"\u2022 Optional save : ( data : Partial < D >, callback? : () => void ) => void","title":"save"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/","text":"Interface: WizardLayoutProps # Renderer . Component .WizardLayoutProps Hierarchy # DOMAttributes < any > \u21b3 WizardLayoutProps Table of contents # Properties # centered className contentClass header headerClass infoPanel infoPanelClass Properties # centered # \u2022 Optional centered : boolean className # \u2022 Optional className : IClassName contentClass # \u2022 Optional contentClass : IClassName header # \u2022 Optional header : ReactNode headerClass # \u2022 Optional headerClass : IClassName infoPanel # \u2022 Optional infoPanel : ReactNode infoPanelClass # \u2022 Optional infoPanelClass : IClassName","title":"Interface: WizardLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#interface-wizardlayoutprops","text":"Renderer . Component .WizardLayoutProps","title":"Interface: WizardLayoutProps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#hierarchy","text":"DOMAttributes < any > \u21b3 WizardLayoutProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#properties","text":"centered className contentClass header headerClass infoPanel infoPanelClass","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#centered","text":"\u2022 Optional centered : boolean","title":"centered"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#classname","text":"\u2022 Optional className : IClassName","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#contentclass","text":"\u2022 Optional contentClass : IClassName","title":"contentClass"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#header","text":"\u2022 Optional header : ReactNode","title":"header"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#headerclass","text":"\u2022 Optional headerClass : IClassName","title":"headerClass"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#infopanel","text":"\u2022 Optional infoPanel : ReactNode","title":"infoPanel"},{"location":"extensions/api/interfaces/Renderer.Component.WizardLayoutProps/#infopanelclass","text":"\u2022 Optional infoPanelClass : IClassName","title":"infoPanelClass"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/","text":"Interface: WizardProps # Renderer . Component .WizardProps Type parameters # Name D Hierarchy # WizardCommonProps < D > \u21b3 WizardProps Table of contents # Properties # children className data done header hideSteps onChange reset save step title Properties # children # \u2022 Optional children : ReactElement < WizardStepProps < D >, string | JSXElementConstructor < any >> | ReactElement < WizardStepProps < D >, string | JSXElementConstructor < any >>[] className # \u2022 Optional className : string data # \u2022 Optional data : Partial < D > Inherited from # WizardCommonProps . data done # \u2022 Optional done : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # WizardCommonProps . done header # \u2022 Optional header : ReactNode hideSteps # \u2022 Optional hideSteps : boolean Inherited from # WizardCommonProps . hideSteps onChange # \u2022 Optional onChange : ( step : number ) => void Type declaration # \u25b8 ( step ): void Parameters # Name Type step number Returns # void reset # \u2022 Optional reset : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # WizardCommonProps . reset save # \u2022 Optional save : ( data : Partial < D >, callback? : () => void ) => void Type declaration # \u25b8 ( data , callback? ): void Parameters # Name Type data Partial < D > callback? () => void Returns # void Inherited from # WizardCommonProps . save step # \u2022 Optional step : number title # \u2022 Optional title : string","title":"Interface: WizardProps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#interface-wizardpropsd","text":"Renderer . Component .WizardProps","title":"Interface: WizardProps<D>"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#hierarchy","text":"WizardCommonProps < D > \u21b3 WizardProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#properties","text":"children className data done header hideSteps onChange reset save step title","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#children","text":"\u2022 Optional children : ReactElement < WizardStepProps < D >, string | JSXElementConstructor < any >> | ReactElement < WizardStepProps < D >, string | JSXElementConstructor < any >>[]","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#classname","text":"\u2022 Optional className : string","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#data","text":"\u2022 Optional data : Partial < D >","title":"data"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#done","text":"\u2022 Optional done : () => void","title":"done"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#header","text":"\u2022 Optional header : ReactNode","title":"header"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#hidesteps","text":"\u2022 Optional hideSteps : boolean","title":"hideSteps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#onchange","text":"\u2022 Optional onChange : ( step : number ) => void","title":"onChange"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#reset","text":"\u2022 Optional reset : () => void","title":"reset"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#save","text":"\u2022 Optional save : ( data : Partial < D >, callback? : () => void ) => void","title":"save"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#step","text":"\u2022 Optional step : number","title":"step"},{"location":"extensions/api/interfaces/Renderer.Component.WizardProps/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/","text":"Interface: WizardStepProps # Renderer . Component .WizardStepProps Type parameters # Name D Hierarchy # WizardCommonProps < D > \u21b3 WizardStepProps Table of contents # Properties # afterContent beforeContent children className contentClass customButtons data disabledNext done first hideBackBtn hideNextBtn hideSteps isFirst isLast last loading moreButtons next nextLabel noValidate prev prevLabel reset save scrollable skip step testIdForNext testIdForPrev title waiting wizard Properties # afterContent # \u2022 Optional afterContent : ReactNode beforeContent # \u2022 Optional beforeContent : ReactNode children # \u2022 Optional children : ReactNode | ReactNode [] className # \u2022 Optional className : string | object contentClass # \u2022 Optional contentClass : string | object customButtons # \u2022 Optional customButtons : ReactNode data # \u2022 Optional data : Partial < D > Inherited from # WizardCommonProps . data disabledNext # \u2022 Optional disabledNext : boolean done # \u2022 Optional done : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # WizardCommonProps . done first # \u2022 Optional first : () => void Type declaration # \u25b8 (): void Returns # void hideBackBtn # \u2022 Optional hideBackBtn : boolean hideNextBtn # \u2022 Optional hideNextBtn : boolean hideSteps # \u2022 Optional hideSteps : boolean Inherited from # WizardCommonProps . hideSteps isFirst # \u2022 Optional isFirst : () => boolean Type declaration # \u25b8 (): boolean Returns # boolean isLast # \u2022 Optional isLast : () => boolean Type declaration # \u25b8 (): boolean Returns # boolean last # \u2022 Optional last : () => void Type declaration # \u25b8 (): void Returns # void loading # \u2022 Optional loading : boolean moreButtons # \u2022 Optional moreButtons : ReactNode next # \u2022 Optional next : () => boolean | void | Promise < any > Type declaration # \u25b8 (): boolean | void | Promise < any > Returns # boolean | void | Promise < any > nextLabel # \u2022 Optional nextLabel : ReactNode noValidate # \u2022 Optional noValidate : boolean prev # \u2022 Optional prev : () => void Type declaration # \u25b8 (): void Returns # void prevLabel # \u2022 Optional prevLabel : ReactNode reset # \u2022 Optional reset : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # WizardCommonProps . reset save # \u2022 Optional save : ( data : Partial < D >, callback? : () => void ) => void Type declaration # \u25b8 ( data , callback? ): void Parameters # Name Type data Partial < D > callback? () => void Returns # void Inherited from # WizardCommonProps . save scrollable # \u2022 Optional scrollable : boolean skip # \u2022 Optional skip : boolean step # \u2022 Optional step : number testIdForNext # \u2022 Optional testIdForNext : string testIdForPrev # \u2022 Optional testIdForPrev : string title # \u2022 Optional title : string waiting # \u2022 Optional waiting : boolean wizard # \u2022 Optional wizard : Wizard < D >","title":"Interface: WizardStepProps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#interface-wizardsteppropsd","text":"Renderer . Component .WizardStepProps","title":"Interface: WizardStepProps<D>"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hierarchy","text":"WizardCommonProps < D > \u21b3 WizardStepProps","title":"Hierarchy"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#properties","text":"afterContent beforeContent children className contentClass customButtons data disabledNext done first hideBackBtn hideNextBtn hideSteps isFirst isLast last loading moreButtons next nextLabel noValidate prev prevLabel reset save scrollable skip step testIdForNext testIdForPrev title waiting wizard","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#aftercontent","text":"\u2022 Optional afterContent : ReactNode","title":"afterContent"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#beforecontent","text":"\u2022 Optional beforeContent : ReactNode","title":"beforeContent"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#children","text":"\u2022 Optional children : ReactNode | ReactNode []","title":"children"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#classname","text":"\u2022 Optional className : string | object","title":"className"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#contentclass","text":"\u2022 Optional contentClass : string | object","title":"contentClass"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#custombuttons","text":"\u2022 Optional customButtons : ReactNode","title":"customButtons"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#data","text":"\u2022 Optional data : Partial < D >","title":"data"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#disablednext","text":"\u2022 Optional disabledNext : boolean","title":"disabledNext"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#done","text":"\u2022 Optional done : () => void","title":"done"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#first","text":"\u2022 Optional first : () => void","title":"first"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hidebackbtn","text":"\u2022 Optional hideBackBtn : boolean","title":"hideBackBtn"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hidenextbtn","text":"\u2022 Optional hideNextBtn : boolean","title":"hideNextBtn"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#hidesteps","text":"\u2022 Optional hideSteps : boolean","title":"hideSteps"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#isfirst","text":"\u2022 Optional isFirst : () => boolean","title":"isFirst"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#islast","text":"\u2022 Optional isLast : () => boolean","title":"isLast"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#last","text":"\u2022 Optional last : () => void","title":"last"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#loading","text":"\u2022 Optional loading : boolean","title":"loading"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#morebuttons","text":"\u2022 Optional moreButtons : ReactNode","title":"moreButtons"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#next","text":"\u2022 Optional next : () => boolean | void | Promise < any >","title":"next"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#nextlabel","text":"\u2022 Optional nextLabel : ReactNode","title":"nextLabel"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#novalidate","text":"\u2022 Optional noValidate : boolean","title":"noValidate"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#prev","text":"\u2022 Optional prev : () => void","title":"prev"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#prevlabel","text":"\u2022 Optional prevLabel : ReactNode","title":"prevLabel"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#reset","text":"\u2022 Optional reset : () => void","title":"reset"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#save","text":"\u2022 Optional save : ( data : Partial < D >, callback? : () => void ) => void","title":"save"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#scrollable","text":"\u2022 Optional scrollable : boolean","title":"scrollable"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#skip","text":"\u2022 Optional skip : boolean","title":"skip"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#step","text":"\u2022 Optional step : number","title":"step"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#testidfornext","text":"\u2022 Optional testIdForNext : string","title":"testIdForNext"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#testidforprev","text":"\u2022 Optional testIdForPrev : string","title":"testIdForPrev"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#title","text":"\u2022 Optional title : string","title":"title"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#waiting","text":"\u2022 Optional waiting : boolean","title":"waiting"},{"location":"extensions/api/interfaces/Renderer.Component.WizardStepProps/#wizard","text":"\u2022 Optional wizard : Wizard < D >","title":"wizard"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IKubeApiCluster/","text":"Interface: IKubeApiCluster # Renderer . K8sApi .IKubeApiCluster Deprecated This type is unused Table of contents # Properties # metadata Properties # metadata # \u2022 metadata : Object Type declaration # Name Type uid string","title":"Interface: IKubeApiCluster"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IKubeApiCluster/#interface-ikubeapicluster","text":"Renderer . K8sApi .IKubeApiCluster Deprecated This type is unused","title":"Interface: IKubeApiCluster"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IKubeApiCluster/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IKubeApiCluster/#properties","text":"metadata","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IKubeApiCluster/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IKubeApiCluster/#metadata","text":"\u2022 metadata : Object","title":"metadata"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/","text":"Interface: IgnoredKubeApiOptions # Renderer . K8sApi .IgnoredKubeApiOptions Deprecated This type is only present for backwards compatable typescript support Table of contents # Properties # apiBase isNamespaces kind objectConstructor Properties # apiBase # \u2022 Optional apiBase : any Deprecated this option is overridden and should not be used isNamespaces # \u2022 Optional isNamespaces : any Deprecated this option is overridden and should not be used kind # \u2022 Optional kind : any Deprecated this option is overridden and should not be used objectConstructor # \u2022 Optional objectConstructor : any Deprecated this option is overridden and should not be used","title":"Interface: IgnoredKubeApiOptions"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#interface-ignoredkubeapioptions","text":"Renderer . K8sApi .IgnoredKubeApiOptions Deprecated This type is only present for backwards compatable typescript support","title":"Interface: IgnoredKubeApiOptions"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#properties","text":"apiBase isNamespaces kind objectConstructor","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#apibase","text":"\u2022 Optional apiBase : any Deprecated this option is overridden and should not be used","title":"apiBase"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#isnamespaces","text":"\u2022 Optional isNamespaces : any Deprecated this option is overridden and should not be used","title":"isNamespaces"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#kind","text":"\u2022 Optional kind : any Deprecated this option is overridden and should not be used","title":"kind"},{"location":"extensions/api/interfaces/Renderer.K8sApi.IgnoredKubeApiOptions/#objectconstructor","text":"\u2022 Optional objectConstructor : any Deprecated this option is overridden and should not be used","title":"objectConstructor"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/","text":"Interface: KubeObjectStatus # Renderer . K8sApi .KubeObjectStatus Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Table of contents # Properties # level text timestamp Properties # level # \u2022 level : KubeObjectStatusLevel text # \u2022 text : string timestamp # \u2022 Optional timestamp : string","title":"Interface: KubeObjectStatus"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#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.","title":"Interface: KubeObjectStatus"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#properties","text":"level text timestamp","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#level","text":"\u2022 level : KubeObjectStatusLevel","title":"level"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#text","text":"\u2022 text : string","title":"text"},{"location":"extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/#timestamp","text":"\u2022 Optional timestamp : string","title":"timestamp"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/","text":"Interface: MetricData # Renderer . K8sApi .MetricData Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Table of contents # Properties # data status Properties # data # \u2022 data : Object Type declaration # Name Type result MetricResult [] resultType string status # \u2022 status : string","title":"Interface: MetricData"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#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.","title":"Interface: MetricData"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#properties","text":"data status","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#data","text":"\u2022 data : Object","title":"data"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricData/#status","text":"\u2022 status : string","title":"status"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/","text":"Interface: MetricResult # Renderer . K8sApi .MetricResult Table of contents # Properties # metric values Properties # metric # \u2022 metric : Object Index signature # \u25aa [name: string ]: string | undefined Type declaration # Name Type instance? string kubernetes? string kubernetes_namespace? string kubernetes_node? string node? string pod? string values # \u2022 values : [ number , string ][]","title":"Interface: MetricResult"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#interface-metricresult","text":"Renderer . K8sApi .MetricResult","title":"Interface: MetricResult"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#properties","text":"metric values","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#metric","text":"\u2022 metric : Object","title":"metric"},{"location":"extensions/api/interfaces/Renderer.K8sApi.MetricResult/#values","text":"\u2022 values : [ number , string ][]","title":"values"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/","text":"Interface: RequestMetricsParams # Renderer . K8sApi .RequestMetricsParams Table of contents # Properties # end namespace range start step Properties # end # \u2022 Optional end : string | number timestamp in seconds or valid date-string namespace # \u2022 Optional namespace : string rbac-proxy validation param range # \u2022 Optional range : number time-range in seconds for data aggregation Default 3600 (1 hour) start # \u2022 Optional start : string | number timestamp in seconds or valid date-string step # \u2022 Optional step : number step in seconds Default 60 (1 minute)","title":"Interface: RequestMetricsParams"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#interface-requestmetricsparams","text":"Renderer . K8sApi .RequestMetricsParams","title":"Interface: RequestMetricsParams"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#properties","text":"end namespace range start step","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#end","text":"\u2022 Optional end : string | number timestamp in seconds or valid date-string","title":"end"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#namespace","text":"\u2022 Optional namespace : string rbac-proxy validation param","title":"namespace"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#range","text":"\u2022 Optional range : number time-range in seconds for data aggregation Default 3600 (1 hour)","title":"range"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#start","text":"\u2022 Optional start : string | number timestamp in seconds or valid date-string","title":"start"},{"location":"extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/#step","text":"\u2022 Optional step : number step in seconds Default 60 (1 minute)","title":"step"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/","text":"Interface: PageParamInit # Renderer . Navigation .PageParamInit Type parameters # Name Type Value any Table of contents # Properties # defaultValue name Methods # parse stringify Properties # defaultValue # \u2022 Optional defaultValue : Value name # \u2022 name : string Methods # parse # \u25b8 Optional parse ( value ): Value Parameters # Name Type value string | string [] Returns # Value stringify # \u25b8 Optional stringify ( value ): string | string [] Parameters # Name Type value Value Returns # string | string []","title":"Interface: PageParamInit"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#interface-pageparaminitvalue","text":"Renderer . Navigation .PageParamInit","title":"Interface: PageParamInit<Value>"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#type-parameters","text":"Name Type Value any","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#properties","text":"defaultValue name","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#methods","text":"parse stringify","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#defaultvalue","text":"\u2022 Optional defaultValue : Value","title":"defaultValue"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#parse","text":"\u25b8 Optional parse ( value ): Value","title":"parse"},{"location":"extensions/api/interfaces/Renderer.Navigation.PageParamInit/#stringify","text":"\u25b8 Optional stringify ( value ): string | string []","title":"stringify"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/","text":"Interface: URLParams # Renderer . Navigation .URLParams Type parameters # Name Type P extends object = {} Q extends object = {} Table of contents # Properties # fragment params query Properties # fragment # \u2022 Optional fragment : string params # \u2022 Optional params : P query # \u2022 Optional query : Q","title":"Interface: URLParams"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#interface-urlparamsp-q","text":"Renderer . Navigation .URLParams","title":"Interface: URLParams<P, Q>"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#type-parameters","text":"Name Type P extends object = {} Q extends object = {}","title":"Type parameters"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#properties","text":"fragment params query","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#fragment","text":"\u2022 Optional fragment : string","title":"fragment"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#params","text":"\u2022 Optional params : P","title":"params"},{"location":"extensions/api/interfaces/Renderer.Navigation.URLParams/#query","text":"\u2022 Optional query : Q","title":"query"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/","text":"Interface: LensTheme # Renderer . Theme .LensTheme Table of contents # Properties # author colors description isDefault monacoTheme name terminalColors type Properties # author # \u2022 author : string colors # \u2022 colors : Record < LensColorName , string > description # \u2022 description : string isDefault # \u2022 Optional isDefault : boolean monacoTheme # \u2022 monacoTheme : MonacoTheme name # \u2022 name : string terminalColors # \u2022 terminalColors : Partial < Record < TerminalColorName , string >> type # \u2022 type : LensThemeType","title":"Interface: LensTheme"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#interface-lenstheme","text":"Renderer . Theme .LensTheme","title":"Interface: LensTheme"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#properties","text":"author colors description isDefault monacoTheme name terminalColors type","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#author","text":"\u2022 author : string","title":"author"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#colors","text":"\u2022 colors : Record < LensColorName , string >","title":"colors"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#description","text":"\u2022 description : string","title":"description"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#isdefault","text":"\u2022 Optional isDefault : boolean","title":"isDefault"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#monacotheme","text":"\u2022 monacoTheme : MonacoTheme","title":"monacoTheme"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#name","text":"\u2022 name : string","title":"name"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#terminalcolors","text":"\u2022 terminalColors : Partial < Record < TerminalColorName , string >>","title":"terminalColors"},{"location":"extensions/api/interfaces/Renderer.Theme.LensTheme/#type","text":"\u2022 type : LensThemeType","title":"type"},{"location":"extensions/api/modules/Common.Catalog/","text":"Namespace: Catalog # Common .Catalog Table of contents # Classes # CatalogCategory CatalogEntity GeneralEntity KubernetesCluster KubernetesClusterCategory WebLink Interfaces # CatalogCategoryEvents CatalogCategoryMetadata CatalogCategorySpec CatalogCategoryVersion CatalogEntityActionContext CatalogEntityAddMenu CatalogEntityAddMenuContext CatalogEntityContextMenu CatalogEntityContextMenuContext CatalogEntityContextMenuNavigate CatalogEntityData CatalogEntityKindData CatalogEntityMetadata CatalogEntitySettingsContext CatalogEntitySettingsMenu CatalogEntityStatus CategoryColumnRegistration GeneralEntitySpec KubernetesClusterMetadata KubernetesClusterPrometheusMetrics KubernetesClusterSpec KubernetesClusterStatus TitleCellProps WebLinkSpec WebLinkStatus Type Aliases # AddMenuFilter CatalogEntityConstructor CatalogEntityDataFor CatalogEntityInstanceFrom CatalogEntitySpec EntityMetadataObject EntityMetadataValue KubernetesClusterStatusPhase WebLinkStatusPhase Variables # kubernetesClusterCategory Functions # categoryVersion Type Aliases # AddMenuFilter # \u01ac AddMenuFilter : ( menu : CatalogEntityAddMenu ) => any Type declaration # \u25b8 ( menu ): any If the filter return a thruthy value, the menu item is displayed Parameters # Name Type menu CatalogEntityAddMenu Returns # any CatalogEntityConstructor # \u01ac CatalogEntityConstructor < Entity >: ( data : CatalogEntityDataFor < Entity >) => Entity Type parameters # Name Type Entity extends CatalogEntity Type declaration # \u2022 ( data ) Parameters # Name Type data CatalogEntityDataFor < Entity > CatalogEntityDataFor # \u01ac CatalogEntityDataFor < Entity >: Entity extends CatalogEntity ? CatalogEntityData < Metadata , Status , Spec > : never Type parameters # Name Entity CatalogEntityInstanceFrom # \u01ac CatalogEntityInstanceFrom < Constructor >: Constructor extends CatalogEntityConstructor ? Entity : never Type parameters # Name Constructor CatalogEntitySpec # \u01ac CatalogEntitySpec : Record < string , any > EntityMetadataObject # \u01ac EntityMetadataObject : { [Key in string]?: EntityMetadataValue } EntityMetadataValue # \u01ac EntityMetadataValue : string | number | boolean | EntityMetadataObject | undefined KubernetesClusterStatusPhase # \u01ac KubernetesClusterStatusPhase : \"connected\" | \"connecting\" | \"disconnected\" | \"deleting\" Deprecated This is no longer used as it is incorrect. Other sources can add more values WebLinkStatusPhase # \u01ac WebLinkStatusPhase : \"available\" | \"unavailable\" Variables # kubernetesClusterCategory # \u2022 Const kubernetesClusterCategory : KubernetesClusterCategory Functions # categoryVersion # \u25b8 categoryVersion < T , Metadata , Status , Spec >( name , entityClass ): CatalogCategoryVersion Type parameters # Name Type T extends CatalogEntity < Metadata , Status , Spec , T > Metadata extends CatalogEntityMetadata < Metadata > Status extends CatalogEntityStatus Spec extends CatalogEntitySpec Parameters # Name Type name string entityClass ( data : CatalogEntityData < Metadata , Status , Spec >) => T Returns # CatalogCategoryVersion","title":"Namespace: Catalog"},{"location":"extensions/api/modules/Common.Catalog/#namespace-catalog","text":"Common .Catalog","title":"Namespace: Catalog"},{"location":"extensions/api/modules/Common.Catalog/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Common.Catalog/#classes","text":"CatalogCategory CatalogEntity GeneralEntity KubernetesCluster KubernetesClusterCategory WebLink","title":"Classes"},{"location":"extensions/api/modules/Common.Catalog/#interfaces","text":"CatalogCategoryEvents CatalogCategoryMetadata CatalogCategorySpec CatalogCategoryVersion CatalogEntityActionContext CatalogEntityAddMenu CatalogEntityAddMenuContext CatalogEntityContextMenu CatalogEntityContextMenuContext CatalogEntityContextMenuNavigate CatalogEntityData CatalogEntityKindData CatalogEntityMetadata CatalogEntitySettingsContext CatalogEntitySettingsMenu CatalogEntityStatus CategoryColumnRegistration GeneralEntitySpec KubernetesClusterMetadata KubernetesClusterPrometheusMetrics KubernetesClusterSpec KubernetesClusterStatus TitleCellProps WebLinkSpec WebLinkStatus","title":"Interfaces"},{"location":"extensions/api/modules/Common.Catalog/#type-aliases","text":"AddMenuFilter CatalogEntityConstructor CatalogEntityDataFor CatalogEntityInstanceFrom CatalogEntitySpec EntityMetadataObject EntityMetadataValue KubernetesClusterStatusPhase WebLinkStatusPhase","title":"Type Aliases"},{"location":"extensions/api/modules/Common.Catalog/#variables","text":"kubernetesClusterCategory","title":"Variables"},{"location":"extensions/api/modules/Common.Catalog/#functions","text":"categoryVersion","title":"Functions"},{"location":"extensions/api/modules/Common.Catalog/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Common.Catalog/#addmenufilter","text":"\u01ac AddMenuFilter : ( menu : CatalogEntityAddMenu ) => any","title":"AddMenuFilter"},{"location":"extensions/api/modules/Common.Catalog/#catalogentityconstructor","text":"\u01ac CatalogEntityConstructor < Entity >: ( data : CatalogEntityDataFor < Entity >) => Entity","title":"CatalogEntityConstructor"},{"location":"extensions/api/modules/Common.Catalog/#catalogentitydatafor","text":"\u01ac CatalogEntityDataFor < Entity >: Entity extends CatalogEntity ? CatalogEntityData < Metadata , Status , Spec > : never","title":"CatalogEntityDataFor"},{"location":"extensions/api/modules/Common.Catalog/#catalogentityinstancefrom","text":"\u01ac CatalogEntityInstanceFrom < Constructor >: Constructor extends CatalogEntityConstructor ? Entity : never","title":"CatalogEntityInstanceFrom"},{"location":"extensions/api/modules/Common.Catalog/#catalogentityspec","text":"\u01ac CatalogEntitySpec : Record < string , any >","title":"CatalogEntitySpec"},{"location":"extensions/api/modules/Common.Catalog/#entitymetadataobject","text":"\u01ac EntityMetadataObject : { [Key in string]?: EntityMetadataValue }","title":"EntityMetadataObject"},{"location":"extensions/api/modules/Common.Catalog/#entitymetadatavalue","text":"\u01ac EntityMetadataValue : string | number | boolean | EntityMetadataObject | undefined","title":"EntityMetadataValue"},{"location":"extensions/api/modules/Common.Catalog/#kubernetesclusterstatusphase","text":"\u01ac KubernetesClusterStatusPhase : \"connected\" | \"connecting\" | \"disconnected\" | \"deleting\" Deprecated This is no longer used as it is incorrect. Other sources can add more values","title":"KubernetesClusterStatusPhase"},{"location":"extensions/api/modules/Common.Catalog/#weblinkstatusphase","text":"\u01ac WebLinkStatusPhase : \"available\" | \"unavailable\"","title":"WebLinkStatusPhase"},{"location":"extensions/api/modules/Common.Catalog/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Common.Catalog/#kubernetesclustercategory","text":"\u2022 Const kubernetesClusterCategory : KubernetesClusterCategory","title":"kubernetesClusterCategory"},{"location":"extensions/api/modules/Common.Catalog/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Common.Catalog/#categoryversion","text":"\u25b8 categoryVersion < T , Metadata , Status , Spec >( name , entityClass ): CatalogCategoryVersion","title":"categoryVersion"},{"location":"extensions/api/modules/Common.EventBus/","text":"Namespace: EventBus # Common .EventBus Table of contents # Classes # EventEmitter Interfaces # AppEvent EventEmitterOptions Type Aliases # EventEmitterCallback Variables # appEventBus Type Aliases # EventEmitterCallback # \u01ac EventEmitterCallback < D >: (... data : D ) => void | boolean Type parameters # Name Type D extends any [] Type declaration # \u25b8 ( ...data ): void | boolean Parameters # Name Type ...data D Returns # void | boolean Variables # appEventBus # \u2022 Const appEventBus : EventEmitter <[ AppEvent ]>","title":"Namespace: EventBus"},{"location":"extensions/api/modules/Common.EventBus/#namespace-eventbus","text":"Common .EventBus","title":"Namespace: EventBus"},{"location":"extensions/api/modules/Common.EventBus/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Common.EventBus/#classes","text":"EventEmitter","title":"Classes"},{"location":"extensions/api/modules/Common.EventBus/#interfaces","text":"AppEvent EventEmitterOptions","title":"Interfaces"},{"location":"extensions/api/modules/Common.EventBus/#type-aliases","text":"EventEmitterCallback","title":"Type Aliases"},{"location":"extensions/api/modules/Common.EventBus/#variables","text":"appEventBus","title":"Variables"},{"location":"extensions/api/modules/Common.EventBus/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Common.EventBus/#eventemittercallback","text":"\u01ac EventEmitterCallback < D >: (... data : D ) => void | boolean","title":"EventEmitterCallback"},{"location":"extensions/api/modules/Common.EventBus/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Common.EventBus/#appeventbus","text":"\u2022 Const appEventBus : EventEmitter <[ AppEvent ]>","title":"appEventBus"},{"location":"extensions/api/modules/Common.Proxy/","text":"Namespace: Proxy # Common .Proxy Table of contents # Functions # resolveSystemProxy Functions # resolveSystemProxy # \u25b8 resolveSystemProxy ( url ): Promise < string > Resolves URL-specific proxy information from system. See more here: https://www.electronjs.org/docs/latest/api/session#sesresolveproxyurl Parameters # Name Type Description url string The URL for proxy information Returns # Promise < string > Promise for proxy information as string","title":"Namespace: Proxy"},{"location":"extensions/api/modules/Common.Proxy/#namespace-proxy","text":"Common .Proxy","title":"Namespace: Proxy"},{"location":"extensions/api/modules/Common.Proxy/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Common.Proxy/#functions","text":"resolveSystemProxy","title":"Functions"},{"location":"extensions/api/modules/Common.Proxy/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Common.Proxy/#resolvesystemproxy","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","title":"resolveSystemProxy"},{"location":"extensions/api/modules/Common.Store/","text":"Namespace: Store # Common .Store Table of contents # Classes # ExtensionStore Interfaces # BaseStoreParams","title":"Namespace: Store"},{"location":"extensions/api/modules/Common.Store/#namespace-store","text":"Common .Store","title":"Namespace: Store"},{"location":"extensions/api/modules/Common.Store/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Common.Store/#classes","text":"ExtensionStore","title":"Classes"},{"location":"extensions/api/modules/Common.Store/#interfaces","text":"BaseStoreParams","title":"Interfaces"},{"location":"extensions/api/modules/Common.Types/","text":"Namespace: Types # Common .Types Table of contents # Interfaces # AppPreferenceComponents AppPreferenceRegistration ClusterPageMenuComponents ClusterPageMenuRegistration CustomCategoryViewComponents CustomCategoryViewProps CustomCategoryViewRegistration KubeObjectContextMenuItem KubeObjectDetailComponents KubeObjectDetailRegistration KubeObjectHandlers KubeObjectMenuComponents KubeObjectMenuRegistration KubeObjectOnContextMenuOpenContext KubeObjectStatusRegistration PageComponentProps PageComponents PageParams PageRegistration PageTarget ProtocolHandlerRegistration ProtocolRouteHandler ProtocolRouteParams RegisteredPage ShellEnvContext StatusBarRegistration TrayMenuRegistration Type Aliases # IpcMainEvent IpcMainInvokeEvent IpcRendererEvent KubeObjectHandlerRegistration KubeObjectOnContextMenuOpen MenuRegistration ShellEnvModifier Type Aliases # IpcMainEvent # \u01ac IpcMainEvent : Electron.IpcMainEvent IpcMainInvokeEvent # \u01ac IpcMainInvokeEvent : Electron.IpcMainInvokeEvent Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. IpcRendererEvent # \u01ac IpcRendererEvent : Electron.IpcRendererEvent KubeObjectHandlerRegistration # \u01ac KubeObjectHandlerRegistration : { apiVersions : string [] ; kind : string } & RequireAtLeastOne < KubeObjectHandlers > KubeObjectOnContextMenuOpen # \u01ac KubeObjectOnContextMenuOpen : ( ctx : KubeObjectOnContextMenuOpenContext ) => void Type declaration # \u25b8 ( ctx ): void Parameters # Name Type ctx KubeObjectOnContextMenuOpenContext Returns # void MenuRegistration # \u01ac MenuRegistration : { parentId : string ; visible? : IComputedValue < boolean > | boolean } & Omit < MenuItemConstructorOptions , \"visible\" > ShellEnvModifier # \u01ac ShellEnvModifier : ( ctx : ShellEnvContext , env : Record < string , string | undefined >) => Record < string , string | undefined > Type declaration # \u25b8 ( ctx , env ): Record < string , string | undefined > Parameters # Name Type ctx ShellEnvContext env Record < string , string | undefined > Returns # Record < string , string | undefined >","title":"Namespace: Types"},{"location":"extensions/api/modules/Common.Types/#namespace-types","text":"Common .Types","title":"Namespace: Types"},{"location":"extensions/api/modules/Common.Types/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Common.Types/#interfaces","text":"AppPreferenceComponents AppPreferenceRegistration ClusterPageMenuComponents ClusterPageMenuRegistration CustomCategoryViewComponents CustomCategoryViewProps CustomCategoryViewRegistration KubeObjectContextMenuItem KubeObjectDetailComponents KubeObjectDetailRegistration KubeObjectHandlers KubeObjectMenuComponents KubeObjectMenuRegistration KubeObjectOnContextMenuOpenContext KubeObjectStatusRegistration PageComponentProps PageComponents PageParams PageRegistration PageTarget ProtocolHandlerRegistration ProtocolRouteHandler ProtocolRouteParams RegisteredPage ShellEnvContext StatusBarRegistration TrayMenuRegistration","title":"Interfaces"},{"location":"extensions/api/modules/Common.Types/#type-aliases","text":"IpcMainEvent IpcMainInvokeEvent IpcRendererEvent KubeObjectHandlerRegistration KubeObjectOnContextMenuOpen MenuRegistration ShellEnvModifier","title":"Type Aliases"},{"location":"extensions/api/modules/Common.Types/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Common.Types/#ipcmainevent","text":"\u01ac IpcMainEvent : Electron.IpcMainEvent","title":"IpcMainEvent"},{"location":"extensions/api/modules/Common.Types/#ipcmaininvokeevent","text":"\u01ac IpcMainInvokeEvent : Electron.IpcMainInvokeEvent Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"IpcMainInvokeEvent"},{"location":"extensions/api/modules/Common.Types/#ipcrendererevent","text":"\u01ac IpcRendererEvent : Electron.IpcRendererEvent","title":"IpcRendererEvent"},{"location":"extensions/api/modules/Common.Types/#kubeobjecthandlerregistration","text":"\u01ac KubeObjectHandlerRegistration : { apiVersions : string [] ; kind : string } & RequireAtLeastOne < KubeObjectHandlers >","title":"KubeObjectHandlerRegistration"},{"location":"extensions/api/modules/Common.Types/#kubeobjectoncontextmenuopen","text":"\u01ac KubeObjectOnContextMenuOpen : ( ctx : KubeObjectOnContextMenuOpenContext ) => void","title":"KubeObjectOnContextMenuOpen"},{"location":"extensions/api/modules/Common.Types/#menuregistration","text":"\u01ac MenuRegistration : { parentId : string ; visible? : IComputedValue < boolean > | boolean } & Omit < MenuItemConstructorOptions , \"visible\" >","title":"MenuRegistration"},{"location":"extensions/api/modules/Common.Types/#shellenvmodifier","text":"\u01ac ShellEnvModifier : ( ctx : ShellEnvContext , env : Record < string , string | undefined >) => Record < string , string | undefined >","title":"ShellEnvModifier"},{"location":"extensions/api/modules/Common.Util/","text":"Namespace: Util # Common .Util Table of contents # Classes # Singleton Interfaces # Disposable Disposer ExtendableDisposer Type Aliases # IClassName IgnoredClassNames OpenLinkInBrowser Functions # cssNames disposer getAppVersion openBrowser openExternal prevDefault stopPropagation Type Aliases # IClassName # \u01ac IClassName : string | string [] | Record < string , any > | undefined | null | false | IgnoredClassNames 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. OpenLinkInBrowser # \u01ac OpenLinkInBrowser : ( url : string ) => Promise < void > Type declaration # \u25b8 ( url ): Promise < void > Parameters # Name Type url string Returns # Promise < void > Functions # cssNames # \u25b8 cssNames ( ...classNames ): string Parameters # Name Type ...classNames IClassName [] Returns # string disposer # \u25b8 disposer ( ...items ): ExtendableDisposer Parameters # Name Type ...items SingleOrMany < undefined | null | Disposer | Disposable >[] Returns # ExtendableDisposer getAppVersion # \u25b8 getAppVersion (): string Returns # string openBrowser # \u25b8 openBrowser ( url ): Promise < void > Parameters # Name Type url string Returns # Promise < void > openExternal # \u25b8 openExternal ( url ): Promise < void > Parameters # Name Type url string Returns # Promise < void > prevDefault # \u25b8 prevDefault < E , R >( callback ): ( event : E ) => R Type parameters # Name Type E extends Event | SyntheticEvent < Element , Event > R R Parameters # Name Type callback ( evt : E ) => R Returns # fn \u25b8 ( event ): R Parameters # Name Type event E Returns # R stopPropagation # \u25b8 stopPropagation ( evt ): void Parameters # Name Type evt Event | SyntheticEvent < Element , Event > Returns # void","title":"Namespace: Util"},{"location":"extensions/api/modules/Common.Util/#namespace-util","text":"Common .Util","title":"Namespace: Util"},{"location":"extensions/api/modules/Common.Util/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Common.Util/#classes","text":"Singleton","title":"Classes"},{"location":"extensions/api/modules/Common.Util/#interfaces","text":"Disposable Disposer ExtendableDisposer","title":"Interfaces"},{"location":"extensions/api/modules/Common.Util/#type-aliases","text":"IClassName IgnoredClassNames OpenLinkInBrowser","title":"Type Aliases"},{"location":"extensions/api/modules/Common.Util/#functions","text":"cssNames disposer getAppVersion openBrowser openExternal prevDefault stopPropagation","title":"Functions"},{"location":"extensions/api/modules/Common.Util/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Common.Util/#iclassname","text":"\u01ac IClassName : string | string [] | Record < string , any > | undefined | null | false | IgnoredClassNames","title":"IClassName"},{"location":"extensions/api/modules/Common.Util/#ignoredclassnames","text":"\u01ac IgnoredClassNames : number | symbol | Function Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"IgnoredClassNames"},{"location":"extensions/api/modules/Common.Util/#openlinkinbrowser","text":"\u01ac OpenLinkInBrowser : ( url : string ) => Promise < void >","title":"OpenLinkInBrowser"},{"location":"extensions/api/modules/Common.Util/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Common.Util/#cssnames","text":"\u25b8 cssNames ( ...classNames ): string","title":"cssNames"},{"location":"extensions/api/modules/Common.Util/#disposer","text":"\u25b8 disposer ( ...items ): ExtendableDisposer","title":"disposer"},{"location":"extensions/api/modules/Common.Util/#getappversion","text":"\u25b8 getAppVersion (): string","title":"getAppVersion"},{"location":"extensions/api/modules/Common.Util/#openbrowser","text":"\u25b8 openBrowser ( url ): Promise < void >","title":"openBrowser"},{"location":"extensions/api/modules/Common.Util/#openexternal","text":"\u25b8 openExternal ( url ): Promise < void >","title":"openExternal"},{"location":"extensions/api/modules/Common.Util/#prevdefault","text":"\u25b8 prevDefault < E , R >( callback ): ( event : E ) => R","title":"prevDefault"},{"location":"extensions/api/modules/Common.Util/#stoppropagation","text":"\u25b8 stopPropagation ( evt ): void","title":"stopPropagation"},{"location":"extensions/api/modules/Common/","text":"Namespace: Common # Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Table of contents # Namespaces # Catalog EventBus Proxy Store Types Util Classes # LensExtension Interfaces # InstalledExtension LensExtensionManifest Logger Variables # App logger Variables # App # \u2022 Const App : Object Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Type declaration # Name Type Preferences { getKubectlPath : () => string | undefined } Preferences.getKubectlPath () => string | undefined appName string getEnabledExtensions () => string [] isLinux boolean isMac boolean isSnap boolean isWindows boolean issuesTrackerUrl string slackUrl string version string logger # \u2022 Const logger : Logger","title":"Namespace: Common"},{"location":"extensions/api/modules/Common/#namespace-common","text":"Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"Namespace: Common"},{"location":"extensions/api/modules/Common/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Common/#namespaces","text":"Catalog EventBus Proxy Store Types Util","title":"Namespaces"},{"location":"extensions/api/modules/Common/#classes","text":"LensExtension","title":"Classes"},{"location":"extensions/api/modules/Common/#interfaces","text":"InstalledExtension LensExtensionManifest Logger","title":"Interfaces"},{"location":"extensions/api/modules/Common/#variables","text":"App logger","title":"Variables"},{"location":"extensions/api/modules/Common/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Common/#app","text":"\u2022 Const App : Object Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"App"},{"location":"extensions/api/modules/Common/#logger","text":"\u2022 Const logger : Logger","title":"logger"},{"location":"extensions/api/modules/Main.Catalog/","text":"Namespace: Catalog # Main .Catalog Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Table of contents # Interfaces # CatalogEntityRegistry Variables # catalogCategories catalogEntities Variables # catalogCategories # \u2022 Const catalogCategories : CatalogCategoryRegistry catalogEntities # \u2022 Const catalogEntities : CatalogEntityRegistry","title":"Namespace: Catalog"},{"location":"extensions/api/modules/Main.Catalog/#namespace-catalog","text":"Main .Catalog Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"Namespace: Catalog"},{"location":"extensions/api/modules/Main.Catalog/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Main.Catalog/#interfaces","text":"CatalogEntityRegistry","title":"Interfaces"},{"location":"extensions/api/modules/Main.Catalog/#variables","text":"catalogCategories catalogEntities","title":"Variables"},{"location":"extensions/api/modules/Main.Catalog/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Main.Catalog/#catalogcategories","text":"\u2022 Const catalogCategories : CatalogCategoryRegistry","title":"catalogCategories"},{"location":"extensions/api/modules/Main.Catalog/#catalogentities","text":"\u2022 Const catalogEntities : CatalogEntityRegistry","title":"catalogEntities"},{"location":"extensions/api/modules/Main.K8sApi/","text":"Namespace: K8sApi # Main .K8sApi Table of contents # Classes # ClusterRole ClusterRoleBinding ConfigMap CronJob CustomResourceDefinition DaemonSet Deployment Endpoint HorizontalPodAutoscaler Ingress Job KubeEvent KubeObject KubeObjectStore KubeStatus LimitRange Namespace NetworkPolicy Node PersistentVolume PersistentVolumeClaim Pod PodDisruptionBudget PriorityClass ReplicaSet ResourceQuota ResourceStack Role RoleBinding Secret Service ServiceAccount StatefulSet StorageClass Interfaces # BaseKubeJsonApiObjectMetadata IKubeApiCluster ILocalKubeApiConfig IPodContainer IPodContainerStatus IRemoteKubeApiConfig ISecretRef IgnoredKubeApiOptions KubeJsonApiData KubeObjectStoreLoadAllParams KubeObjectStoreLoadingParams KubeObjectStoreSubscribeParams KubeStatusData OwnerReference Type Aliases # ClusterScopedMetadata DeploymentApi IngressApi JsonPatch KubeApi KubeJsonApi KubeJsonApiDataFor KubeJsonApiObjectMetadata KubeObjectMetadata NamespaceScopedMetadata NodesApi PersistentVolumeClaimsApi PodsApi Variables # DeploymentApi IngressApi KubeApi KubeJsonApi NodesApi PersistentVolumeClaimsApi PodsApi apiManager Functions # createResourceStack forCluster forRemoteCluster isAllowedResource Type Aliases # ClusterScopedMetadata # \u01ac ClusterScopedMetadata : KubeObjectMetadata < KubeObjectScope.Cluster > DeploymentApi # \u01ac DeploymentApi : InternalDeploymentApi IngressApi # \u01ac IngressApi : InternalIngressApi JsonPatch # \u01ac JsonPatch : Patch KubeApi # \u01ac KubeApi < Object , Data >: InternalKubeApi < Object , Data > Type parameters # Name Type Object extends KubeObject = KubeObject Data extends KubeJsonApiDataFor < Object > = KubeJsonApiDataFor < Object > KubeJsonApi # \u01ac KubeJsonApi : InternalKubeJsonApi KubeJsonApiDataFor # \u01ac KubeJsonApiDataFor < K >: K extends KubeObject ? KubeJsonApiData < Metadata , Status , Spec > : never Type parameters # Name K KubeJsonApiObjectMetadata # \u01ac KubeJsonApiObjectMetadata < Namespaced >: BaseKubeJsonApiObjectMetadata < Namespaced > & Namespaced extends KubeObjectScope.Namespace ? { namespace : string } : {} Type parameters # Name Type Namespaced extends KubeObjectScope = KubeObjectScope KubeObjectMetadata # \u01ac KubeObjectMetadata < Namespaced >: KubeJsonApiObjectMetadata < Namespaced > & { name : string ; resourceVersion : string ; selfLink : string ; uid : string } Type parameters # Name Type Namespaced extends KubeObjectScope = KubeObjectScope NamespaceScopedMetadata # \u01ac NamespaceScopedMetadata : KubeObjectMetadata < KubeObjectScope.Namespace > NodesApi # \u01ac NodesApi : NodeApi PersistentVolumeClaimsApi # \u01ac PersistentVolumeClaimsApi : PersistentVolumeClaimApi PodsApi # \u01ac PodsApi : PodApi Variables # DeploymentApi # \u2022 DeploymentApi : ( opts? : DerivedKubeApiOptions ) => DeploymentApi Type declaration # \u2022 new DeploymentApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions IngressApi # \u2022 IngressApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => IngressApi Type declaration # \u2022 new IngressApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions KubeApi # \u2022 KubeApi : ( opts : KubeApiOptions < Object_1 , Data >) => KubeApi < Object_1 , Data > Type declaration # \u2022 new KubeApi < Object_1 , Data >( opts ) Type parameters # Name Type 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 > Parameters # Name Type opts KubeApiOptions < Object_1 , Data > KubeJsonApi # \u2022 KubeJsonApi : ( config : JsonApiConfig , reqInit? : RequestInit ) => KubeJsonApi & { forCluster : CreateKubeJsonApiForCluster } NodesApi # \u2022 NodesApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => NodeApi Type declaration # \u2022 new NodesApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions PersistentVolumeClaimsApi # \u2022 PersistentVolumeClaimsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PersistentVolumeClaimApi Type declaration # \u2022 new PersistentVolumeClaimsApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions PodsApi # \u2022 PodsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PodApi Type declaration # \u2022 new PodsApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions apiManager # \u2022 Const apiManager : ApiManager Functions # createResourceStack # \u25b8 createResourceStack ( cluster , name ): ResourceApplyingStack Parameters # Name Type cluster KubernetesCluster < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > name string Returns # ResourceApplyingStack forCluster # \u25b8 forCluster < Object , Api , Data >( cluster , kubeClass , apiClass ): Api Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Api extends KubeApi < Object , KubeJsonApiDataFor < Object >, Api > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type cluster ILocalKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass KubeApiConstructor < Object , Api > Returns # Api \u25b8 forCluster < Object , Data >( cluster , kubeClass , apiClass? ): KubeApi < Object , KubeJsonApiDataFor < Object >> Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type cluster ILocalKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass? KubeApiConstructor < Object , KubeApi < Object , KubeJsonApiDataFor < Object >>> Returns # KubeApi < Object , KubeJsonApiDataFor < Object >> forRemoteCluster # \u25b8 forRemoteCluster < Object , Api , Data >( config , kubeClass , apiClass ): Api Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Api extends KubeApi < Object , KubeJsonApiDataFor < Object >, Api > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type config IRemoteKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass KubeApiConstructor < Object , Api > Returns # Api \u25b8 forRemoteCluster < Object , Data >( config , kubeClass , apiClass? ): KubeApi < Object , KubeJsonApiDataFor < Object >> Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type config IRemoteKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass? KubeApiConstructor < Object , KubeApi < Object , KubeJsonApiDataFor < Object >>> Returns # KubeApi < Object , KubeJsonApiDataFor < Object >> isAllowedResource # \u25b8 isAllowedResource ( ...args ): boolean Deprecated This function never works Parameters # Name Type ...args any [] Returns # boolean false","title":"Namespace: K8sApi"},{"location":"extensions/api/modules/Main.K8sApi/#namespace-k8sapi","text":"Main .K8sApi","title":"Namespace: K8sApi"},{"location":"extensions/api/modules/Main.K8sApi/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Main.K8sApi/#classes","text":"ClusterRole ClusterRoleBinding ConfigMap CronJob CustomResourceDefinition DaemonSet Deployment Endpoint HorizontalPodAutoscaler Ingress Job KubeEvent KubeObject KubeObjectStore KubeStatus LimitRange Namespace NetworkPolicy Node PersistentVolume PersistentVolumeClaim Pod PodDisruptionBudget PriorityClass ReplicaSet ResourceQuota ResourceStack Role RoleBinding Secret Service ServiceAccount StatefulSet StorageClass","title":"Classes"},{"location":"extensions/api/modules/Main.K8sApi/#interfaces","text":"BaseKubeJsonApiObjectMetadata IKubeApiCluster ILocalKubeApiConfig IPodContainer IPodContainerStatus IRemoteKubeApiConfig ISecretRef IgnoredKubeApiOptions KubeJsonApiData KubeObjectStoreLoadAllParams KubeObjectStoreLoadingParams KubeObjectStoreSubscribeParams KubeStatusData OwnerReference","title":"Interfaces"},{"location":"extensions/api/modules/Main.K8sApi/#type-aliases","text":"ClusterScopedMetadata DeploymentApi IngressApi JsonPatch KubeApi KubeJsonApi KubeJsonApiDataFor KubeJsonApiObjectMetadata KubeObjectMetadata NamespaceScopedMetadata NodesApi PersistentVolumeClaimsApi PodsApi","title":"Type Aliases"},{"location":"extensions/api/modules/Main.K8sApi/#variables","text":"DeploymentApi IngressApi KubeApi KubeJsonApi NodesApi PersistentVolumeClaimsApi PodsApi apiManager","title":"Variables"},{"location":"extensions/api/modules/Main.K8sApi/#functions","text":"createResourceStack forCluster forRemoteCluster isAllowedResource","title":"Functions"},{"location":"extensions/api/modules/Main.K8sApi/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Main.K8sApi/#clusterscopedmetadata","text":"\u01ac ClusterScopedMetadata : KubeObjectMetadata < KubeObjectScope.Cluster >","title":"ClusterScopedMetadata"},{"location":"extensions/api/modules/Main.K8sApi/#deploymentapi","text":"\u01ac DeploymentApi : InternalDeploymentApi","title":"DeploymentApi"},{"location":"extensions/api/modules/Main.K8sApi/#ingressapi","text":"\u01ac IngressApi : InternalIngressApi","title":"IngressApi"},{"location":"extensions/api/modules/Main.K8sApi/#jsonpatch","text":"\u01ac JsonPatch : Patch","title":"JsonPatch"},{"location":"extensions/api/modules/Main.K8sApi/#kubeapi","text":"\u01ac KubeApi < Object , Data >: InternalKubeApi < Object , Data >","title":"KubeApi"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapi","text":"\u01ac KubeJsonApi : InternalKubeJsonApi","title":"KubeJsonApi"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapidatafor","text":"\u01ac KubeJsonApiDataFor < K >: K extends KubeObject ? KubeJsonApiData < Metadata , Status , Spec > : never","title":"KubeJsonApiDataFor"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapiobjectmetadata","text":"\u01ac KubeJsonApiObjectMetadata < Namespaced >: BaseKubeJsonApiObjectMetadata < Namespaced > & Namespaced extends KubeObjectScope.Namespace ? { namespace : string } : {}","title":"KubeJsonApiObjectMetadata"},{"location":"extensions/api/modules/Main.K8sApi/#kubeobjectmetadata","text":"\u01ac KubeObjectMetadata < Namespaced >: KubeJsonApiObjectMetadata < Namespaced > & { name : string ; resourceVersion : string ; selfLink : string ; uid : string }","title":"KubeObjectMetadata"},{"location":"extensions/api/modules/Main.K8sApi/#namespacescopedmetadata","text":"\u01ac NamespaceScopedMetadata : KubeObjectMetadata < KubeObjectScope.Namespace >","title":"NamespaceScopedMetadata"},{"location":"extensions/api/modules/Main.K8sApi/#nodesapi","text":"\u01ac NodesApi : NodeApi","title":"NodesApi"},{"location":"extensions/api/modules/Main.K8sApi/#persistentvolumeclaimsapi","text":"\u01ac PersistentVolumeClaimsApi : PersistentVolumeClaimApi","title":"PersistentVolumeClaimsApi"},{"location":"extensions/api/modules/Main.K8sApi/#podsapi","text":"\u01ac PodsApi : PodApi","title":"PodsApi"},{"location":"extensions/api/modules/Main.K8sApi/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Main.K8sApi/#deploymentapi_1","text":"\u2022 DeploymentApi : ( opts? : DerivedKubeApiOptions ) => DeploymentApi","title":"DeploymentApi"},{"location":"extensions/api/modules/Main.K8sApi/#ingressapi_1","text":"\u2022 IngressApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => IngressApi","title":"IngressApi"},{"location":"extensions/api/modules/Main.K8sApi/#kubeapi_1","text":"\u2022 KubeApi : ( opts : KubeApiOptions < Object_1 , Data >) => KubeApi < Object_1 , Data >","title":"KubeApi"},{"location":"extensions/api/modules/Main.K8sApi/#kubejsonapi_1","text":"\u2022 KubeJsonApi : ( config : JsonApiConfig , reqInit? : RequestInit ) => KubeJsonApi & { forCluster : CreateKubeJsonApiForCluster }","title":"KubeJsonApi"},{"location":"extensions/api/modules/Main.K8sApi/#nodesapi_1","text":"\u2022 NodesApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => NodeApi","title":"NodesApi"},{"location":"extensions/api/modules/Main.K8sApi/#persistentvolumeclaimsapi_1","text":"\u2022 PersistentVolumeClaimsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PersistentVolumeClaimApi","title":"PersistentVolumeClaimsApi"},{"location":"extensions/api/modules/Main.K8sApi/#podsapi_1","text":"\u2022 PodsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PodApi","title":"PodsApi"},{"location":"extensions/api/modules/Main.K8sApi/#apimanager","text":"\u2022 Const apiManager : ApiManager","title":"apiManager"},{"location":"extensions/api/modules/Main.K8sApi/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Main.K8sApi/#createresourcestack","text":"\u25b8 createResourceStack ( cluster , name ): ResourceApplyingStack","title":"createResourceStack"},{"location":"extensions/api/modules/Main.K8sApi/#forcluster","text":"\u25b8 forCluster < Object , Api , Data >( cluster , kubeClass , apiClass ): Api","title":"forCluster"},{"location":"extensions/api/modules/Main.K8sApi/#forremotecluster","text":"\u25b8 forRemoteCluster < Object , Api , Data >( config , kubeClass , apiClass ): Api","title":"forRemoteCluster"},{"location":"extensions/api/modules/Main.K8sApi/#isallowedresource","text":"\u25b8 isAllowedResource ( ...args ): boolean Deprecated This function never works","title":"isAllowedResource"},{"location":"extensions/api/modules/Main.Navigation/","text":"Namespace: Navigation # Main .Navigation Table of contents # Functions # navigate Functions # navigate # \u25b8 navigate ( url ): Promise < void > Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Parameters # Name Type url string Returns # Promise < void >","title":"Namespace: Navigation"},{"location":"extensions/api/modules/Main.Navigation/#namespace-navigation","text":"Main .Navigation","title":"Namespace: Navigation"},{"location":"extensions/api/modules/Main.Navigation/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Main.Navigation/#functions","text":"navigate","title":"Functions"},{"location":"extensions/api/modules/Main.Navigation/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Main.Navigation/#navigate","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.","title":"navigate"},{"location":"extensions/api/modules/Main.Power/","text":"Namespace: Power # Main .Power Table of contents # Type Aliases # PowerEventListener Functions # onResume onShutdown onSuspend Type Aliases # PowerEventListener # \u01ac PowerEventListener : () => void Type declaration # \u25b8 (): void Event listener for system power events Returns # void Functions # onResume # \u25b8 onResume ( listener ): Disposer Adds event listener to system resume event Parameters # Name Type Description listener PowerEventListener function which will be called on system resume Returns # Disposer function to remove event listener onShutdown # \u25b8 onShutdown ( listener ): Disposer Adds event listener to the event which is emitted when the system is about to reboot or shut down Parameters # Name Type Description listener PowerEventListener function which will be called on system shutdown Returns # Disposer function to remove event listener onSuspend # \u25b8 onSuspend ( listener ): Disposer Adds event listener to system suspend events Parameters # Name Type Description listener PowerEventListener function which will be called on system suspend Returns # Disposer function to remove event listener","title":"Namespace: Power"},{"location":"extensions/api/modules/Main.Power/#namespace-power","text":"Main .Power","title":"Namespace: Power"},{"location":"extensions/api/modules/Main.Power/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Main.Power/#type-aliases","text":"PowerEventListener","title":"Type Aliases"},{"location":"extensions/api/modules/Main.Power/#functions","text":"onResume onShutdown onSuspend","title":"Functions"},{"location":"extensions/api/modules/Main.Power/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Main.Power/#powereventlistener","text":"\u01ac PowerEventListener : () => void","title":"PowerEventListener"},{"location":"extensions/api/modules/Main.Power/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Main.Power/#onresume","text":"\u25b8 onResume ( listener ): Disposer Adds event listener to system resume event","title":"onResume"},{"location":"extensions/api/modules/Main.Power/#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","title":"onShutdown"},{"location":"extensions/api/modules/Main.Power/#onsuspend","text":"\u25b8 onSuspend ( listener ): Disposer Adds event listener to system suspend events","title":"onSuspend"},{"location":"extensions/api/modules/Main/","text":"Namespace: Main # Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information. Table of contents # Namespaces # Catalog K8sApi Navigation Power Classes # Ipc LensExtension","title":"Namespace: Main"},{"location":"extensions/api/modules/Main/#namespace-main","text":"Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.","title":"Namespace: Main"},{"location":"extensions/api/modules/Main/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Main/#namespaces","text":"Catalog K8sApi Navigation Power","title":"Namespaces"},{"location":"extensions/api/modules/Main/#classes","text":"Ipc LensExtension","title":"Classes"},{"location":"extensions/api/modules/Renderer.Catalog/","text":"Namespace: Catalog # Renderer .Catalog Table of contents # Classes # CatalogEntityRegistry Variables # activeCluster catalogCategories catalogEntities Variables # activeCluster # \u2022 Const activeCluster : IComputedValue catalogCategories # \u2022 Const catalogCategories : CatalogCategoryRegistry catalogEntities # \u2022 Const catalogEntities : CatalogEntityRegistry","title":"Namespace: Catalog"},{"location":"extensions/api/modules/Renderer.Catalog/#namespace-catalog","text":"Renderer .Catalog","title":"Namespace: Catalog"},{"location":"extensions/api/modules/Renderer.Catalog/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Renderer.Catalog/#classes","text":"CatalogEntityRegistry","title":"Classes"},{"location":"extensions/api/modules/Renderer.Catalog/#variables","text":"activeCluster catalogCategories catalogEntities","title":"Variables"},{"location":"extensions/api/modules/Renderer.Catalog/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Renderer.Catalog/#activecluster","text":"\u2022 Const activeCluster : IComputedValue","title":"activeCluster"},{"location":"extensions/api/modules/Renderer.Catalog/#catalogcategories","text":"\u2022 Const catalogCategories : CatalogCategoryRegistry","title":"catalogCategories"},{"location":"extensions/api/modules/Renderer.Catalog/#catalogentities","text":"\u2022 Const catalogEntities : CatalogEntityRegistry","title":"catalogEntities"},{"location":"extensions/api/modules/Renderer.Component/","text":"Namespace: Component # Renderer .Component Table of contents # References # CategoryColumnRegistration Enumerations # NotificationStatus TooltipPosition Classes # DrawerParamToggler Input MenuItem NotificationsStore PageLayout SettingLayout Slider Spinner Stepper SubTitle Tab TableCell TableHead TableRow Tabs TerminalStore Tooltip Wizard WizardLayout WizardStep Interfaces # AdditionalCategoryColumnRegistration BadgeProps BarChartProps BaseIconProps ButtonProps CheckboxProps ConfirmDialogBooleanParams ConfirmDialogParams ConfirmDialogProps CreateNotificationOptions CustomPlaceholderProps DialogProps DrawerItemLabelsProps DrawerItemProps DrawerParamTogglerProps DrawerProps DrawerTitleProps IconDataFnArg IconProps KubeEventDetailsProps KubeObjectDetailsProps KubeObjectListLayoutProps KubeObjectMenuProps KubeObjectMetaProps LineProgressProps MainLayoutProps MenuActionsProps MenuContextValue MenuItemProps MenuPosition MenuProps MenuStyle MonacoEditorProps NamespaceSelectProps Notification PieChartData PieChartProps PodDetailsListProps RadioGroupProps RadioProps SearchInputProps SelectOption SelectProps SettingLayoutProps SliderProps SpinnerProps StatusBrickProps StepperProps SubTitleProps SwitchProps SwitcherProps TabLayoutProps TabLayoutRoute TabProps TableCellProps TableHeadProps TableProps TableRowProps TableSortParams TabsProps TooltipContentFormatters TooltipDecoratorProps TooltipProps WizardCommonProps WizardLayoutProps WizardProps WizardStepProps Type Aliases # DatasetTooltipLabel DrawerPosition IconData InputProps InputValidation InputValidationResult InputValidator LegacyAutoConvertedOptions MonacoCustomTheme MonacoEditorId MonacoTheme NamespaceSelectSort NotificationId NotificationMessage ShowNotification SyncValidationMessage TableCellElem TableHeadElem TableOrderBy TableRowElem TableSortBy TableSortCallback TableSortCallbacks Variables # CommandOverlay InputValidators MenuContext Notifications cpuOptions logTabStore memoryOptions notificationsStore resizingAnchorProps terminalStore Functions # Badge BarChart Button Checkbox ConfirmDialog Dialog Drawer DrawerItem DrawerItemLabels DrawerTitle FormSwitch Icon KubeEventDetails KubeObjectDetails KubeObjectListLayout KubeObjectMenu KubeObjectMeta LineProgress MainLayout Menu MenuActions MonacoEditor NamespaceSelect NamespaceSelectFilter PieChart PodDetailsList Radio RadioGroup SearchInput Select StatusBrick SubMenu Switch Switcher TabLayout Table asyncInputValidator createTerminalTab getDetailsUrl inputValidator isAsyncValidator isSvg onMultiSelectFor showDetails unionInputValidatorsAsync withTooltip References # CategoryColumnRegistration # Re-exports CategoryColumnRegistration Type Aliases # DatasetTooltipLabel # \u01ac DatasetTooltipLabel : ( percent : string ) => string | string Type declaration # \u25b8 ( percent ): string | string Parameters # Name Type percent string Returns # string | string DrawerPosition # \u01ac DrawerPosition : \"top\" | \"left\" | \"right\" | \"bottom\" IconData # \u01ac IconData : string | React.ReactNode | ( opt : IconDataFnArg ) => React.ReactNode One of the folloing: - A material icon name - A react node - Or a function that produces a react node InputProps # \u01ac InputProps : Omit < InputElementProps , \"onChange\" | \"onSubmit\" > & { autoSelectOnFocus? : boolean ; blurOnEnter? : boolean ; className? : string ; contentRight? : string | React.ReactNode ; 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 } InputValidation # \u01ac InputValidation < IsAsync >: ( value : string , props? : InputProps ) => InputValidationResult < IsAsync > Type parameters # Name Type IsAsync extends boolean Type declaration # \u25b8 ( value , props? ): InputValidationResult < IsAsync > Parameters # Name Type value string props? InputProps Returns # InputValidationResult < IsAsync > InputValidationResult # \u01ac InputValidationResult < IsAsync >: IsAsync extends true ? Promise < void > : boolean Type parameters # Name Type IsAsync extends boolean InputValidator # \u01ac InputValidator < IsAsync >: SyncInputValidator | AsyncInputValidator | IsAsync extends boolean ? LegacyInputValidator : never Type parameters # Name Type IsAsync extends boolean = boolean LegacyAutoConvertedOptions # \u01ac LegacyAutoConvertedOptions : string [] Deprecated This should not be used anymore, convert the options yourself. MonacoCustomTheme # \u01ac MonacoCustomTheme : \"clouds-midnight\" MonacoEditorId # \u01ac MonacoEditorId : string MonacoTheme # \u01ac MonacoTheme : \"vs\" | \"vs-dark\" | \"hc-black\" | MonacoCustomTheme NamespaceSelectSort # \u01ac NamespaceSelectSort : ( left : string , right : string ) => number Type declaration # \u25b8 ( left , right ): number Parameters # Name Type left string right string Returns # number NotificationId # \u01ac NotificationId : string | number NotificationMessage # \u01ac NotificationMessage : string | React.ReactElement | React.ReactElement [] | JsonApiErrorParsed | Error ShowNotification # \u01ac ShowNotification : ( message : NotificationMessage , opts? : CreateNotificationOptions ) => Disposer Type declaration # \u25b8 ( message , opts? ): Disposer Parameters # Name Type message NotificationMessage opts? CreateNotificationOptions Returns # Disposer SyncValidationMessage # \u01ac SyncValidationMessage : React.ReactNode | ( value : string , props? : InputProps ) => React.ReactNode TableCellElem # \u01ac TableCellElem : React.ReactElement < TableCellProps > TableHeadElem # \u01ac TableHeadElem : React.ReactElement < TableHeadProps > TableOrderBy # \u01ac TableOrderBy : \"asc\" | \"desc\" TableRowElem # \u01ac TableRowElem < Item >: React.ReactElement < TableRowProps < Item >> Type parameters # Name Item TableSortBy # \u01ac TableSortBy : string TableSortCallback # \u01ac TableSortCallback < Item >: ( data : Item ) => undefined | string | number | ( string | number )[] Type parameters # Name Item Type declaration # \u25b8 ( data ): undefined | string | number | ( string | number )[] Parameters # Name Type data Item Returns # undefined | string | number | ( string | number )[] TableSortCallbacks # \u01ac TableSortCallbacks < Item >: Record < string , TableSortCallback < Item >> Type parameters # Name Item Variables # CommandOverlay # \u2022 Const CommandOverlay : CommandOverlay InputValidators # \u2022 Const InputValidators : Object Type declaration # Name Type 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 MenuContext # \u2022 Const MenuContext : React.Context < MenuContextValue | null > Notifications # \u2022 Const Notifications : Object Type declaration # Name Type checkedError ShowCheckedErrorNotification error ShowNotification info ShowNotification ok ShowNotification shortInfo ShowNotification cpuOptions # \u2022 Const cpuOptions : ChartOptions logTabStore # \u2022 Const logTabStore : LogTabStore & { createPodTab : ( { selectedPod, selectedContainer } : PodLogsTabData ) => string ; createWorkloadTab : ( { workload } : WorkloadLogsTabData ) => string | undefined ; renameTab : ( tabId : string ) => void ; tabs : undefined } memoryOptions # \u2022 Const memoryOptions : ChartOptions notificationsStore # \u2022 Const notificationsStore : NotificationsStore resizingAnchorProps # \u2022 Const resizingAnchorProps : Record < DrawerPosition , [ ResizeDirection , ResizeSide , ResizeGrowthDirection ]> terminalStore # \u2022 Const terminalStore : TerminalStore & { sendCommand : SendCommand } Functions # Badge # \u25b8 Badge ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < BadgeProps & TooltipDecoratorProps > context? any Returns # null | ReactElement < any , any > BarChart # \u25b8 BarChart ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < BarChartProps > context? any Returns # null | ReactElement < any , any > Button # \u25b8 Button ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < ButtonProps & TooltipDecoratorProps > context? any Returns # null | ReactElement < any , any > Checkbox # \u25b8 Checkbox ( \u00abdestructured\u00bb ): JSX.Element Parameters # Name Type \u00abdestructured\u00bb CheckboxProps Returns # JSX.Element ConfirmDialog # \u25b8 ConfirmDialog ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < ConfirmDialogProps > context? any Returns # null | ReactElement < any , any > Dialog # \u25b8 Dialog ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < DialogProps > context? any Returns # null | ReactElement < any , any > Drawer # \u25b8 Drawer ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < DrawerProps > context? any Returns # null | ReactElement < any , any > DrawerItem # \u25b8 DrawerItem ( \u00abdestructured\u00bb ): JSX.Element | null Parameters # Name Type \u00abdestructured\u00bb DrawerItemProps Returns # JSX.Element | null DrawerItemLabels # \u25b8 DrawerItemLabels ( props ): JSX.Element | null Parameters # Name Type props DrawerItemLabelsProps Returns # JSX.Element | null DrawerTitle # \u25b8 DrawerTitle ( \u00abdestructured\u00bb ): JSX.Element Parameters # Name Type \u00abdestructured\u00bb DrawerTitleProps Returns # JSX.Element FormSwitch # \u25b8 FormSwitch ( props ): React.FunctionComponentElement < any > Deprecated Use instead from \"../switch.tsx\". Parameters # Name Type props FormControlLabelProps & { children? : ReactNode } Returns # React.FunctionComponentElement < any > Icon # \u25b8 Icon ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < IconProps & TooltipDecoratorProps > context? any Returns # null | ReactElement < any , any > KubeEventDetails # \u25b8 KubeEventDetails ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < KubeEventDetailsProps > context? any Returns # null | ReactElement < any , any > KubeObjectDetails # \u25b8 KubeObjectDetails ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props Object context? any Returns # null | ReactElement < any , any > KubeObjectListLayout # \u25b8 KubeObjectListLayout < K , A , D >( props ): ReactElement < any , string | JSXElementConstructor < any >> Type parameters # Name Type K extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , K > A extends KubeApi < K , D , A > D extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , D > = KubeJsonApiDataFor < K > Parameters # Name Type props KubeObjectListLayoutProps < K , A , D > Returns # ReactElement < any , string | JSXElementConstructor < any >> KubeObjectMenu # \u25b8 KubeObjectMenu < T >( props ): ReactElement < any , string | JSXElementConstructor < any >> Type parameters # Name Type T extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , T > Parameters # Name Type props KubeObjectMenuProps < T > Returns # ReactElement < any , string | JSXElementConstructor < any >> KubeObjectMeta # \u25b8 KubeObjectMeta ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < KubeObjectMetaProps > context? any Returns # null | ReactElement < any , any > LineProgress # \u25b8 LineProgress ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < LineProgressProps & TooltipDecoratorProps > context? any Returns # null | ReactElement < any , any > MainLayout # \u25b8 MainLayout ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < MainLayoutProps > context? any Returns # null | ReactElement < any , any > Menu # \u25b8 Menu ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < MenuProps > context? any Returns # null | ReactElement < any , any > MenuActions # \u25b8 MenuActions ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < MenuActionsProps > context? any Returns # null | ReactElement < any , any > MonacoEditor # \u25b8 MonacoEditor ( props ): null | ReactElement < any , string | JSXElementConstructor < any >> NOTE : Exotic components are not callable. Parameters # Name Type props MonacoEditorProps & RefAttributes < MonacoEditorRef > Returns # null | ReactElement < any , string | JSXElementConstructor < any >> NamespaceSelect # \u25b8 NamespaceSelect < IsMulti >( props ): JSX.Element Type parameters # Name Type IsMulti extends boolean = false Parameters # Name Type props NamespaceSelectProps < IsMulti > Returns # JSX.Element NamespaceSelectFilter # \u25b8 NamespaceSelectFilter ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < NamespaceSelectFilterProps > context? any Returns # null | ReactElement < any , any > PieChart # \u25b8 PieChart ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < PieChartProps > context? any Returns # null | ReactElement < any , any > PodDetailsList # \u25b8 PodDetailsList ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < PodDetailsListProps > context? any Returns # null | ReactElement < any , any > Radio # \u25b8 Radio < T >( \u00abdestructured\u00bb ): JSX.Element Type parameters # Name T Parameters # Name Type \u00abdestructured\u00bb RadioProps < T > Returns # JSX.Element RadioGroup # \u25b8 RadioGroup < T >( \u00abdestructured\u00bb ): JSX.Element Type parameters # Name T Parameters # Name Type \u00abdestructured\u00bb RadioGroupProps < T > Returns # JSX.Element SearchInput # \u25b8 SearchInput ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < SearchInputProps > context? any Returns # null | ReactElement < any , any > Select # \u25b8 Select < Value , Option , IsMulti , Group >( props ): ReactElement < any , string | JSXElementConstructor < any >> Type parameters # Name Type Value Value Option extends SelectOption < Value , Option > IsMulti extends boolean = false Group extends GroupBase < Option , Group > = GroupBase < Option > Parameters # Name Type props SelectProps < Value , Option , IsMulti , Group > Returns # ReactElement < any , string | JSXElementConstructor < any >> StatusBrick # \u25b8 StatusBrick ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < StatusBrickProps & TooltipDecoratorProps > context? any Returns # null | ReactElement < any , any > SubMenu # \u25b8 SubMenu ( props ): JSX.Element Parameters # Name Type props Partial < MenuProps > Returns # JSX.Element Switch # \u25b8 Switch ( \u00abdestructured\u00bb ): JSX.Element Parameters # Name Type \u00abdestructured\u00bb SwitchProps Returns # JSX.Element Switcher # \u25b8 Switcher ( \u00abdestructured\u00bb ): JSX.Element Deprecated Use instead from \"../switch.tsx\". Parameters # Name Type \u00abdestructured\u00bb SwitcherProps Returns # JSX.Element TabLayout # \u25b8 TabLayout ( props , context? ): null | ReactElement < any , any > Parameters # Name Type props PropsWithChildren < TabLayoutProps > context? any Returns # null | ReactElement < any , any > Table # \u25b8 Table < Item >( props ): ReactElement < any , string | JSXElementConstructor < any >> Type parameters # Name Item Parameters # Name Type props TableProps < Item > Returns # ReactElement < any , string | JSXElementConstructor < any >> asyncInputValidator # \u25b8 asyncInputValidator ( validator ): AsyncInputValidator A helper function to create an AsyncInputValidator Parameters # Name Type validator AsyncInputValidator Returns # AsyncInputValidator createTerminalTab # \u25b8 createTerminalTab ( tabParams? ): Required < DockTabCreate > Parameters # Name Type tabParams? DockTabCreateSpecific Returns # Required < DockTabCreate > getDetailsUrl # \u25b8 getDetailsUrl ( selfLink , resetSelected? , mergeGlobals? ): string Deprecated Use Renderer.Navigation.getDetailsUrl Parameters # Name Type selfLink string resetSelected? boolean mergeGlobals? boolean Returns # string inputValidator # \u25b8 inputValidator ( validator ): SyncInputValidator A helper function to create an SyncInputValidator Parameters # Name Type validator SyncInputValidator Returns # SyncInputValidator isAsyncValidator # \u25b8 isAsyncValidator ( validator ): validator is AsyncInputValidator Parameters # Name Type validator InputValidator < boolean > Returns # validator is AsyncInputValidator isSvg # \u25b8 isSvg ( content ): boolean Parameters # Name Type content string Returns # boolean onMultiSelectFor # \u25b8 onMultiSelectFor < Value , Option , Group >( collection ): SelectProps < Value , Option , true , Group >[ \"onChange\" ] Type parameters # Name Type Value Value Option extends SelectOption < Value , Option > Group extends GroupBase < Option , Group > = GroupBase < Option > Parameters # Name Type collection Set < Value > | ObservableSet < Value > Returns # SelectProps < Value , Option , true , Group >[ \"onChange\" ] showDetails # \u25b8 showDetails ( selfLink , resetSelected? ): void Deprecated Use Renderer.Navigation.showDetails Parameters # Name Type selfLink undefined | string resetSelected? boolean Returns # void unionInputValidatorsAsync # \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 Parameters # Name Type baseValidator Simplify < Except < Pick < InputValidator < boolean >, \"message\" | \"condition\" >, \"message\" > & Required < Pick < Pick < InputValidator < boolean >, \"message\" | \"condition\" >, \"message\" >>> ...validators InputValidator < boolean >[] Returns # AsyncInputValidator withTooltip # \u25b8 withTooltip < TargetProps >( Target ): React.FunctionComponent < TargetProps & TooltipDecoratorProps > Type parameters # Name TargetProps Parameters # Name Type Target TargetProps extends Pick < TooltipDecoratorProps , \"id\" | \"children\" > ? FunctionComponent < TargetProps > : never Returns # React.FunctionComponent < TargetProps & TooltipDecoratorProps >","title":"Namespace: Component"},{"location":"extensions/api/modules/Renderer.Component/#namespace-component","text":"Renderer .Component","title":"Namespace: Component"},{"location":"extensions/api/modules/Renderer.Component/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Renderer.Component/#references","text":"CategoryColumnRegistration","title":"References"},{"location":"extensions/api/modules/Renderer.Component/#enumerations","text":"NotificationStatus TooltipPosition","title":"Enumerations"},{"location":"extensions/api/modules/Renderer.Component/#classes","text":"DrawerParamToggler Input MenuItem NotificationsStore PageLayout SettingLayout Slider Spinner Stepper SubTitle Tab TableCell TableHead TableRow Tabs TerminalStore Tooltip Wizard WizardLayout WizardStep","title":"Classes"},{"location":"extensions/api/modules/Renderer.Component/#interfaces","text":"AdditionalCategoryColumnRegistration BadgeProps BarChartProps BaseIconProps ButtonProps CheckboxProps ConfirmDialogBooleanParams ConfirmDialogParams ConfirmDialogProps CreateNotificationOptions CustomPlaceholderProps DialogProps DrawerItemLabelsProps DrawerItemProps DrawerParamTogglerProps DrawerProps DrawerTitleProps IconDataFnArg IconProps KubeEventDetailsProps KubeObjectDetailsProps KubeObjectListLayoutProps KubeObjectMenuProps KubeObjectMetaProps LineProgressProps MainLayoutProps MenuActionsProps MenuContextValue MenuItemProps MenuPosition MenuProps MenuStyle MonacoEditorProps NamespaceSelectProps Notification PieChartData PieChartProps PodDetailsListProps RadioGroupProps RadioProps SearchInputProps SelectOption SelectProps SettingLayoutProps SliderProps SpinnerProps StatusBrickProps StepperProps SubTitleProps SwitchProps SwitcherProps TabLayoutProps TabLayoutRoute TabProps TableCellProps TableHeadProps TableProps TableRowProps TableSortParams TabsProps TooltipContentFormatters TooltipDecoratorProps TooltipProps WizardCommonProps WizardLayoutProps WizardProps WizardStepProps","title":"Interfaces"},{"location":"extensions/api/modules/Renderer.Component/#type-aliases","text":"DatasetTooltipLabel DrawerPosition IconData InputProps InputValidation InputValidationResult InputValidator LegacyAutoConvertedOptions MonacoCustomTheme MonacoEditorId MonacoTheme NamespaceSelectSort NotificationId NotificationMessage ShowNotification SyncValidationMessage TableCellElem TableHeadElem TableOrderBy TableRowElem TableSortBy TableSortCallback TableSortCallbacks","title":"Type Aliases"},{"location":"extensions/api/modules/Renderer.Component/#variables","text":"CommandOverlay InputValidators MenuContext Notifications cpuOptions logTabStore memoryOptions notificationsStore resizingAnchorProps terminalStore","title":"Variables"},{"location":"extensions/api/modules/Renderer.Component/#functions","text":"Badge BarChart Button Checkbox ConfirmDialog Dialog Drawer DrawerItem DrawerItemLabels DrawerTitle FormSwitch Icon KubeEventDetails KubeObjectDetails KubeObjectListLayout KubeObjectMenu KubeObjectMeta LineProgress MainLayout Menu MenuActions MonacoEditor NamespaceSelect NamespaceSelectFilter PieChart PodDetailsList Radio RadioGroup SearchInput Select StatusBrick SubMenu Switch Switcher TabLayout Table asyncInputValidator createTerminalTab getDetailsUrl inputValidator isAsyncValidator isSvg onMultiSelectFor showDetails unionInputValidatorsAsync withTooltip","title":"Functions"},{"location":"extensions/api/modules/Renderer.Component/#references_1","text":"","title":"References"},{"location":"extensions/api/modules/Renderer.Component/#categorycolumnregistration","text":"Re-exports CategoryColumnRegistration","title":"CategoryColumnRegistration"},{"location":"extensions/api/modules/Renderer.Component/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Renderer.Component/#datasettooltiplabel","text":"\u01ac DatasetTooltipLabel : ( percent : string ) => string | string","title":"DatasetTooltipLabel"},{"location":"extensions/api/modules/Renderer.Component/#drawerposition","text":"\u01ac DrawerPosition : \"top\" | \"left\" | \"right\" | \"bottom\"","title":"DrawerPosition"},{"location":"extensions/api/modules/Renderer.Component/#icondata","text":"\u01ac IconData : string | React.ReactNode | ( opt : IconDataFnArg ) => React.ReactNode One of the folloing: - A material icon name - A react node - Or a function that produces a react node","title":"IconData"},{"location":"extensions/api/modules/Renderer.Component/#inputprops","text":"\u01ac InputProps : Omit < InputElementProps , \"onChange\" | \"onSubmit\" > & { autoSelectOnFocus? : boolean ; blurOnEnter? : boolean ; className? : string ; contentRight? : string | React.ReactNode ; 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 }","title":"InputProps"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidation","text":"\u01ac InputValidation < IsAsync >: ( value : string , props? : InputProps ) => InputValidationResult < IsAsync >","title":"InputValidation"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidationresult","text":"\u01ac InputValidationResult < IsAsync >: IsAsync extends true ? Promise < void > : boolean","title":"InputValidationResult"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidator","text":"\u01ac InputValidator < IsAsync >: SyncInputValidator | AsyncInputValidator | IsAsync extends boolean ? LegacyInputValidator : never","title":"InputValidator"},{"location":"extensions/api/modules/Renderer.Component/#legacyautoconvertedoptions","text":"\u01ac LegacyAutoConvertedOptions : string [] Deprecated This should not be used anymore, convert the options yourself.","title":"LegacyAutoConvertedOptions"},{"location":"extensions/api/modules/Renderer.Component/#monacocustomtheme","text":"\u01ac MonacoCustomTheme : \"clouds-midnight\"","title":"MonacoCustomTheme"},{"location":"extensions/api/modules/Renderer.Component/#monacoeditorid","text":"\u01ac MonacoEditorId : string","title":"MonacoEditorId"},{"location":"extensions/api/modules/Renderer.Component/#monacotheme","text":"\u01ac MonacoTheme : \"vs\" | \"vs-dark\" | \"hc-black\" | MonacoCustomTheme","title":"MonacoTheme"},{"location":"extensions/api/modules/Renderer.Component/#namespaceselectsort","text":"\u01ac NamespaceSelectSort : ( left : string , right : string ) => number","title":"NamespaceSelectSort"},{"location":"extensions/api/modules/Renderer.Component/#notificationid","text":"\u01ac NotificationId : string | number","title":"NotificationId"},{"location":"extensions/api/modules/Renderer.Component/#notificationmessage","text":"\u01ac NotificationMessage : string | React.ReactElement | React.ReactElement [] | JsonApiErrorParsed | Error","title":"NotificationMessage"},{"location":"extensions/api/modules/Renderer.Component/#shownotification","text":"\u01ac ShowNotification : ( message : NotificationMessage , opts? : CreateNotificationOptions ) => Disposer","title":"ShowNotification"},{"location":"extensions/api/modules/Renderer.Component/#syncvalidationmessage","text":"\u01ac SyncValidationMessage : React.ReactNode | ( value : string , props? : InputProps ) => React.ReactNode","title":"SyncValidationMessage"},{"location":"extensions/api/modules/Renderer.Component/#tablecellelem","text":"\u01ac TableCellElem : React.ReactElement < TableCellProps >","title":"TableCellElem"},{"location":"extensions/api/modules/Renderer.Component/#tableheadelem","text":"\u01ac TableHeadElem : React.ReactElement < TableHeadProps >","title":"TableHeadElem"},{"location":"extensions/api/modules/Renderer.Component/#tableorderby","text":"\u01ac TableOrderBy : \"asc\" | \"desc\"","title":"TableOrderBy"},{"location":"extensions/api/modules/Renderer.Component/#tablerowelem","text":"\u01ac TableRowElem < Item >: React.ReactElement < TableRowProps < Item >>","title":"TableRowElem"},{"location":"extensions/api/modules/Renderer.Component/#tablesortby","text":"\u01ac TableSortBy : string","title":"TableSortBy"},{"location":"extensions/api/modules/Renderer.Component/#tablesortcallback","text":"\u01ac TableSortCallback < Item >: ( data : Item ) => undefined | string | number | ( string | number )[]","title":"TableSortCallback"},{"location":"extensions/api/modules/Renderer.Component/#tablesortcallbacks","text":"\u01ac TableSortCallbacks < Item >: Record < string , TableSortCallback < Item >>","title":"TableSortCallbacks"},{"location":"extensions/api/modules/Renderer.Component/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Renderer.Component/#commandoverlay","text":"\u2022 Const CommandOverlay : CommandOverlay","title":"CommandOverlay"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidators","text":"\u2022 Const InputValidators : Object","title":"InputValidators"},{"location":"extensions/api/modules/Renderer.Component/#menucontext","text":"\u2022 Const MenuContext : React.Context < MenuContextValue | null >","title":"MenuContext"},{"location":"extensions/api/modules/Renderer.Component/#notifications","text":"\u2022 Const Notifications : Object","title":"Notifications"},{"location":"extensions/api/modules/Renderer.Component/#cpuoptions","text":"\u2022 Const cpuOptions : ChartOptions","title":"cpuOptions"},{"location":"extensions/api/modules/Renderer.Component/#logtabstore","text":"\u2022 Const logTabStore : LogTabStore & { createPodTab : ( { selectedPod, selectedContainer } : PodLogsTabData ) => string ; createWorkloadTab : ( { workload } : WorkloadLogsTabData ) => string | undefined ; renameTab : ( tabId : string ) => void ; tabs : undefined }","title":"logTabStore"},{"location":"extensions/api/modules/Renderer.Component/#memoryoptions","text":"\u2022 Const memoryOptions : ChartOptions","title":"memoryOptions"},{"location":"extensions/api/modules/Renderer.Component/#notificationsstore","text":"\u2022 Const notificationsStore : NotificationsStore","title":"notificationsStore"},{"location":"extensions/api/modules/Renderer.Component/#resizinganchorprops","text":"\u2022 Const resizingAnchorProps : Record < DrawerPosition , [ ResizeDirection , ResizeSide , ResizeGrowthDirection ]>","title":"resizingAnchorProps"},{"location":"extensions/api/modules/Renderer.Component/#terminalstore","text":"\u2022 Const terminalStore : TerminalStore & { sendCommand : SendCommand }","title":"terminalStore"},{"location":"extensions/api/modules/Renderer.Component/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Renderer.Component/#badge","text":"\u25b8 Badge ( props , context? ): null | ReactElement < any , any >","title":"Badge"},{"location":"extensions/api/modules/Renderer.Component/#barchart","text":"\u25b8 BarChart ( props , context? ): null | ReactElement < any , any >","title":"BarChart"},{"location":"extensions/api/modules/Renderer.Component/#button","text":"\u25b8 Button ( props , context? ): null | ReactElement < any , any >","title":"Button"},{"location":"extensions/api/modules/Renderer.Component/#checkbox","text":"\u25b8 Checkbox ( \u00abdestructured\u00bb ): JSX.Element","title":"Checkbox"},{"location":"extensions/api/modules/Renderer.Component/#confirmdialog","text":"\u25b8 ConfirmDialog ( props , context? ): null | ReactElement < any , any >","title":"ConfirmDialog"},{"location":"extensions/api/modules/Renderer.Component/#dialog","text":"\u25b8 Dialog ( props , context? ): null | ReactElement < any , any >","title":"Dialog"},{"location":"extensions/api/modules/Renderer.Component/#drawer","text":"\u25b8 Drawer ( props , context? ): null | ReactElement < any , any >","title":"Drawer"},{"location":"extensions/api/modules/Renderer.Component/#draweritem","text":"\u25b8 DrawerItem ( \u00abdestructured\u00bb ): JSX.Element | null","title":"DrawerItem"},{"location":"extensions/api/modules/Renderer.Component/#draweritemlabels","text":"\u25b8 DrawerItemLabels ( props ): JSX.Element | null","title":"DrawerItemLabels"},{"location":"extensions/api/modules/Renderer.Component/#drawertitle","text":"\u25b8 DrawerTitle ( \u00abdestructured\u00bb ): JSX.Element","title":"DrawerTitle"},{"location":"extensions/api/modules/Renderer.Component/#formswitch","text":"\u25b8 FormSwitch ( props ): React.FunctionComponentElement < any > Deprecated Use instead from \"../switch.tsx\".","title":"FormSwitch"},{"location":"extensions/api/modules/Renderer.Component/#icon","text":"\u25b8 Icon ( props , context? ): null | ReactElement < any , any >","title":"Icon"},{"location":"extensions/api/modules/Renderer.Component/#kubeeventdetails","text":"\u25b8 KubeEventDetails ( props , context? ): null | ReactElement < any , any >","title":"KubeEventDetails"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectdetails","text":"\u25b8 KubeObjectDetails ( props , context? ): null | ReactElement < any , any >","title":"KubeObjectDetails"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectlistlayout","text":"\u25b8 KubeObjectListLayout < K , A , D >( props ): ReactElement < any , string | JSXElementConstructor < any >>","title":"KubeObjectListLayout"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectmenu","text":"\u25b8 KubeObjectMenu < T >( props ): ReactElement < any , string | JSXElementConstructor < any >>","title":"KubeObjectMenu"},{"location":"extensions/api/modules/Renderer.Component/#kubeobjectmeta","text":"\u25b8 KubeObjectMeta ( props , context? ): null | ReactElement < any , any >","title":"KubeObjectMeta"},{"location":"extensions/api/modules/Renderer.Component/#lineprogress","text":"\u25b8 LineProgress ( props , context? ): null | ReactElement < any , any >","title":"LineProgress"},{"location":"extensions/api/modules/Renderer.Component/#mainlayout","text":"\u25b8 MainLayout ( props , context? ): null | ReactElement < any , any >","title":"MainLayout"},{"location":"extensions/api/modules/Renderer.Component/#menu","text":"\u25b8 Menu ( props , context? ): null | ReactElement < any , any >","title":"Menu"},{"location":"extensions/api/modules/Renderer.Component/#menuactions","text":"\u25b8 MenuActions ( props , context? ): null | ReactElement < any , any >","title":"MenuActions"},{"location":"extensions/api/modules/Renderer.Component/#monacoeditor","text":"\u25b8 MonacoEditor ( props ): null | ReactElement < any , string | JSXElementConstructor < any >> NOTE : Exotic components are not callable.","title":"MonacoEditor"},{"location":"extensions/api/modules/Renderer.Component/#namespaceselect","text":"\u25b8 NamespaceSelect < IsMulti >( props ): JSX.Element","title":"NamespaceSelect"},{"location":"extensions/api/modules/Renderer.Component/#namespaceselectfilter","text":"\u25b8 NamespaceSelectFilter ( props , context? ): null | ReactElement < any , any >","title":"NamespaceSelectFilter"},{"location":"extensions/api/modules/Renderer.Component/#piechart","text":"\u25b8 PieChart ( props , context? ): null | ReactElement < any , any >","title":"PieChart"},{"location":"extensions/api/modules/Renderer.Component/#poddetailslist","text":"\u25b8 PodDetailsList ( props , context? ): null | ReactElement < any , any >","title":"PodDetailsList"},{"location":"extensions/api/modules/Renderer.Component/#radio","text":"\u25b8 Radio < T >( \u00abdestructured\u00bb ): JSX.Element","title":"Radio"},{"location":"extensions/api/modules/Renderer.Component/#radiogroup","text":"\u25b8 RadioGroup < T >( \u00abdestructured\u00bb ): JSX.Element","title":"RadioGroup"},{"location":"extensions/api/modules/Renderer.Component/#searchinput","text":"\u25b8 SearchInput ( props , context? ): null | ReactElement < any , any >","title":"SearchInput"},{"location":"extensions/api/modules/Renderer.Component/#select","text":"\u25b8 Select < Value , Option , IsMulti , Group >( props ): ReactElement < any , string | JSXElementConstructor < any >>","title":"Select"},{"location":"extensions/api/modules/Renderer.Component/#statusbrick","text":"\u25b8 StatusBrick ( props , context? ): null | ReactElement < any , any >","title":"StatusBrick"},{"location":"extensions/api/modules/Renderer.Component/#submenu","text":"\u25b8 SubMenu ( props ): JSX.Element","title":"SubMenu"},{"location":"extensions/api/modules/Renderer.Component/#switch","text":"\u25b8 Switch ( \u00abdestructured\u00bb ): JSX.Element","title":"Switch"},{"location":"extensions/api/modules/Renderer.Component/#switcher","text":"\u25b8 Switcher ( \u00abdestructured\u00bb ): JSX.Element Deprecated Use instead from \"../switch.tsx\".","title":"Switcher"},{"location":"extensions/api/modules/Renderer.Component/#tablayout","text":"\u25b8 TabLayout ( props , context? ): null | ReactElement < any , any >","title":"TabLayout"},{"location":"extensions/api/modules/Renderer.Component/#table","text":"\u25b8 Table < Item >( props ): ReactElement < any , string | JSXElementConstructor < any >>","title":"Table"},{"location":"extensions/api/modules/Renderer.Component/#asyncinputvalidator","text":"\u25b8 asyncInputValidator ( validator ): AsyncInputValidator A helper function to create an AsyncInputValidator","title":"asyncInputValidator"},{"location":"extensions/api/modules/Renderer.Component/#createterminaltab","text":"\u25b8 createTerminalTab ( tabParams? ): Required < DockTabCreate >","title":"createTerminalTab"},{"location":"extensions/api/modules/Renderer.Component/#getdetailsurl","text":"\u25b8 getDetailsUrl ( selfLink , resetSelected? , mergeGlobals? ): string Deprecated Use Renderer.Navigation.getDetailsUrl","title":"getDetailsUrl"},{"location":"extensions/api/modules/Renderer.Component/#inputvalidator_1","text":"\u25b8 inputValidator ( validator ): SyncInputValidator A helper function to create an SyncInputValidator","title":"inputValidator"},{"location":"extensions/api/modules/Renderer.Component/#isasyncvalidator","text":"\u25b8 isAsyncValidator ( validator ): validator is AsyncInputValidator","title":"isAsyncValidator"},{"location":"extensions/api/modules/Renderer.Component/#issvg","text":"\u25b8 isSvg ( content ): boolean","title":"isSvg"},{"location":"extensions/api/modules/Renderer.Component/#onmultiselectfor","text":"\u25b8 onMultiSelectFor < Value , Option , Group >( collection ): SelectProps < Value , Option , true , Group >[ \"onChange\" ]","title":"onMultiSelectFor"},{"location":"extensions/api/modules/Renderer.Component/#showdetails","text":"\u25b8 showDetails ( selfLink , resetSelected? ): void Deprecated Use Renderer.Navigation.showDetails","title":"showDetails"},{"location":"extensions/api/modules/Renderer.Component/#unioninputvalidatorsasync","text":"\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","title":"unionInputValidatorsAsync"},{"location":"extensions/api/modules/Renderer.Component/#withtooltip","text":"\u25b8 withTooltip < TargetProps >( Target ): React.FunctionComponent < TargetProps & TooltipDecoratorProps >","title":"withTooltip"},{"location":"extensions/api/modules/Renderer.K8sApi/","text":"Namespace: K8sApi # Renderer .K8sApi Table of contents # References # BaseKubeJsonApiObjectMetadata ClusterRole ClusterRoleBinding ClusterScopedMetadata ConfigMap CronJob CustomResourceDefinition DaemonSet Deployment Endpoint HorizontalPodAutoscaler HorizontalPodAutoscalerStore ILocalKubeApiConfig IPodContainer IPodContainerStatus IRemoteKubeApiConfig ISecretRef Ingress Job JsonPatch KubeEvent KubeJsonApiData KubeJsonApiDataFor KubeJsonApiObjectMetadata KubeObject KubeObjectMetadata KubeObjectStoreLoadAllParams KubeObjectStoreLoadingParams KubeObjectStoreSubscribeParams KubeStatus KubeStatusData LimitRange Namespace NamespaceScopedMetadata NetworkPolicy Node OwnerReference PersistentVolume PersistentVolumeClaim Pod PodDisruptionBudget PriorityClass ReplicaSet ResourceQuota Role RoleBinding Secret Service ServiceAccount StatefulSet StorageClass Enumerations # KubeObjectStatusLevel Classes # CRDResourceStore CRDStore ConfigMapsStore CronJobStore DaemonSetStore DeploymentStore EndpointStore EventStore HPAStore IngressClassStore IngressStore JobStore KubeObjectStore LimitRangesStore NamespaceStore NetworkPolicyStore NodesStore PersistentVolumesStore PodDisruptionBudgetsStore PodsStore PriorityClassStoreStore ReplicaSetStore ResourceQuotasStore ResourceStack RoleBindingsStore RolesStore SecretsStore ServiceAccountsStore ServiceStore StatefulSetStore StorageClassStore VerticalPodAutoscalerStore VolumeClaimStore Interfaces # IKubeApiCluster IgnoredKubeApiOptions KubeObjectStatus MetricData MetricResult RequestMetricsParams Type Aliases # DeploymentApi IngressApi KubeApi KubeJsonApi NodesApi PersistentVolumeClaimsApi PodsApi RequestMetrics Variables # DeploymentApi IngressApi KubeApi KubeJsonApi NodesApi PersistentVolumeClaimsApi PodsApi apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi hpaApi ingressApi jobApi limitRangeApi namespacesApi networkPolicyApi nodesApi pcApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi vpaApi Functions # createResourceStack forCluster forRemoteCluster isAllowedResource requestMetrics References # BaseKubeJsonApiObjectMetadata # Re-exports BaseKubeJsonApiObjectMetadata ClusterRole # Re-exports ClusterRole ClusterRoleBinding # Re-exports ClusterRoleBinding ClusterScopedMetadata # Re-exports ClusterScopedMetadata ConfigMap # Re-exports ConfigMap CronJob # Re-exports CronJob CustomResourceDefinition # Re-exports CustomResourceDefinition DaemonSet # Re-exports DaemonSet Deployment # Re-exports Deployment Endpoint # Re-exports Endpoint HorizontalPodAutoscaler # Re-exports HorizontalPodAutoscaler HorizontalPodAutoscalerStore # Renames and re-exports HPAStore ILocalKubeApiConfig # Re-exports ILocalKubeApiConfig IPodContainer # Re-exports IPodContainer IPodContainerStatus # Re-exports IPodContainerStatus IRemoteKubeApiConfig # Re-exports IRemoteKubeApiConfig ISecretRef # Re-exports ISecretRef Ingress # Re-exports Ingress Job # Re-exports Job JsonPatch # Re-exports JsonPatch KubeEvent # Re-exports KubeEvent KubeJsonApiData # Re-exports KubeJsonApiData KubeJsonApiDataFor # Re-exports KubeJsonApiDataFor KubeJsonApiObjectMetadata # Re-exports KubeJsonApiObjectMetadata KubeObject # Re-exports KubeObject KubeObjectMetadata # Re-exports KubeObjectMetadata KubeObjectStoreLoadAllParams # Re-exports KubeObjectStoreLoadAllParams KubeObjectStoreLoadingParams # Re-exports KubeObjectStoreLoadingParams KubeObjectStoreSubscribeParams # Re-exports KubeObjectStoreSubscribeParams KubeStatus # Re-exports KubeStatus KubeStatusData # Re-exports KubeStatusData LimitRange # Re-exports LimitRange Namespace # Re-exports Namespace NamespaceScopedMetadata # Re-exports NamespaceScopedMetadata NetworkPolicy # Re-exports NetworkPolicy Node # Re-exports Node OwnerReference # Re-exports OwnerReference PersistentVolume # Re-exports PersistentVolume PersistentVolumeClaim # Re-exports PersistentVolumeClaim Pod # Re-exports Pod PodDisruptionBudget # Re-exports PodDisruptionBudget PriorityClass # Re-exports PriorityClass ReplicaSet # Re-exports ReplicaSet ResourceQuota # Re-exports ResourceQuota Role # Re-exports Role RoleBinding # Re-exports RoleBinding Secret # Re-exports Secret Service # Re-exports Service ServiceAccount # Re-exports ServiceAccount StatefulSet # Re-exports StatefulSet StorageClass # Re-exports StorageClass Type Aliases # DeploymentApi # \u01ac DeploymentApi : InternalDeploymentApi IngressApi # \u01ac IngressApi : InternalIngressApi KubeApi # \u01ac KubeApi < Object , Data >: InternalKubeApi < Object , Data > Type parameters # Name Type Object extends KubeObject = KubeObject Data extends KubeJsonApiDataFor < Object > = KubeJsonApiDataFor < Object > KubeJsonApi # \u01ac KubeJsonApi : InternalKubeJsonApi NodesApi # \u01ac NodesApi : NodeApi PersistentVolumeClaimsApi # \u01ac PersistentVolumeClaimsApi : PersistentVolumeClaimApi PodsApi # \u01ac PodsApi : PodApi RequestMetrics # \u01ac RequestMetrics : ReturnType Variables # DeploymentApi # \u2022 DeploymentApi : ( opts? : DerivedKubeApiOptions ) => DeploymentApi Type declaration # \u2022 new DeploymentApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions IngressApi # \u2022 IngressApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => IngressApi Type declaration # \u2022 new IngressApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions KubeApi # \u2022 KubeApi : ( opts : KubeApiOptions < Object_1 , Data >) => KubeApi < Object_1 , Data > Type declaration # \u2022 new KubeApi < Object_1 , Data >( opts ) Type parameters # Name Type 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 > Parameters # Name Type opts KubeApiOptions < Object_1 , Data > KubeJsonApi # \u2022 KubeJsonApi : ( config : JsonApiConfig , reqInit? : RequestInit ) => KubeJsonApi & { forCluster : CreateKubeJsonApiForCluster } NodesApi # \u2022 NodesApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => NodeApi Type declaration # \u2022 new NodesApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions PersistentVolumeClaimsApi # \u2022 PersistentVolumeClaimsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PersistentVolumeClaimApi Type declaration # \u2022 new PersistentVolumeClaimsApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions PodsApi # \u2022 PodsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PodApi Type declaration # \u2022 new PodsApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions & IgnoredKubeApiOptions apiManager # \u2022 Const apiManager : ApiManager clusterRoleApi # \u2022 Const clusterRoleApi : ClusterRoleApi clusterRoleBindingApi # \u2022 Const clusterRoleBindingApi : ClusterRoleBindingApi configMapApi # \u2022 Const configMapApi : ConfigMapApi crdApi # \u2022 Const crdApi : CustomResourceDefinitionApi cronJobApi # \u2022 Const cronJobApi : CronJobApi daemonSetApi # \u2022 Const daemonSetApi : DaemonSetApi deploymentApi # \u2022 Const deploymentApi : DeploymentApi endpointApi # \u2022 Const endpointApi : EndpointsApi eventApi # \u2022 Const eventApi : KubeEventApi hpaApi # \u2022 Const hpaApi : HorizontalPodAutoscalerApi ingressApi # \u2022 Const ingressApi : IngressApi jobApi # \u2022 Const jobApi : JobApi limitRangeApi # \u2022 Const limitRangeApi : LimitRangeApi namespacesApi # \u2022 Const namespacesApi : NamespaceApi networkPolicyApi # \u2022 Const networkPolicyApi : NetworkPolicyApi nodesApi # \u2022 Const nodesApi : NodeApi pcApi # \u2022 Const pcApi : PriorityClassApi pdbApi # \u2022 Const pdbApi : PodDisruptionBudgetApi persistentVolumeApi # \u2022 Const persistentVolumeApi : PersistentVolumeApi podsApi # \u2022 Const podsApi : PodApi pvcApi # \u2022 Const pvcApi : PersistentVolumeClaimApi replicaSetApi # \u2022 Const replicaSetApi : ReplicaSetApi resourceQuotaApi # \u2022 Const resourceQuotaApi : ResourceQuotaApi roleApi # \u2022 Const roleApi : RoleApi roleBindingApi # \u2022 Const roleBindingApi : RoleBindingApi secretsApi # \u2022 Const secretsApi : SecretApi serviceAccountsApi # \u2022 Const serviceAccountsApi : ServiceAccountApi serviceApi # \u2022 Const serviceApi : ServiceApi statefulSetApi # \u2022 Const statefulSetApi : StatefulSetApi storageClassApi # \u2022 Const storageClassApi : StorageClassApi vpaApi # \u2022 Const vpaApi : VerticalPodAutoscalerApi Functions # createResourceStack # \u25b8 createResourceStack ( cluster , name ): ResourceApplyingStack Parameters # Name Type cluster KubernetesCluster < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > name string Returns # ResourceApplyingStack forCluster # \u25b8 forCluster < Object , Api , Data >( cluster , kubeClass , apiClass ): Api Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Api extends KubeApi < Object , KubeJsonApiDataFor < Object >, Api > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type cluster ILocalKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass KubeApiConstructor < Object , Api > Returns # Api \u25b8 forCluster < Object , Data >( cluster , kubeClass , apiClass? ): KubeApi < Object , KubeJsonApiDataFor < Object >> Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type cluster ILocalKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass? KubeApiConstructor < Object , KubeApi < Object , KubeJsonApiDataFor < Object >>> Returns # KubeApi < Object , KubeJsonApiDataFor < Object >> forRemoteCluster # \u25b8 forRemoteCluster < Object , Api , Data >( config , kubeClass , apiClass ): Api Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Api extends KubeApi < Object , KubeJsonApiDataFor < Object >, Api > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type config IRemoteKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass KubeApiConstructor < Object , Api > Returns # Api \u25b8 forRemoteCluster < Object , Data >( config , kubeClass , apiClass? ): KubeApi < Object , KubeJsonApiDataFor < Object >> Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > Parameters # Name Type config IRemoteKubeApiConfig kubeClass KubeObjectConstructor < Object , Data > apiClass? KubeApiConstructor < Object , KubeApi < Object , KubeJsonApiDataFor < Object >>> Returns # KubeApi < Object , KubeJsonApiDataFor < Object >> isAllowedResource # \u25b8 isAllowedResource ( resources ): boolean Parameters # Name Type resources KubeResource | KubeResource [] Returns # boolean requestMetrics # \u25b8 requestMetrics ( query , params? ): Promise < MetricData > Parameters # Name Type query string params? RequestMetricsParams Returns # Promise < MetricData > \u25b8 requestMetrics ( query , params? ): Promise < MetricData []> Parameters # Name Type query string [] params? RequestMetricsParams Returns # Promise < MetricData []> \u25b8 requestMetrics < Keys >( query , params? ): Promise < Record < Keys , MetricData >> Type parameters # Name Type Keys extends string Parameters # Name Type query Record < Keys , Partial < Record < string , string >>> params? RequestMetricsParams Returns # Promise < Record < Keys , MetricData >>","title":"Namespace: K8sApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespace-k8sapi","text":"Renderer .K8sApi","title":"Namespace: K8sApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Renderer.K8sApi/#references","text":"BaseKubeJsonApiObjectMetadata ClusterRole ClusterRoleBinding ClusterScopedMetadata ConfigMap CronJob CustomResourceDefinition DaemonSet Deployment Endpoint HorizontalPodAutoscaler HorizontalPodAutoscalerStore ILocalKubeApiConfig IPodContainer IPodContainerStatus IRemoteKubeApiConfig ISecretRef Ingress Job JsonPatch KubeEvent KubeJsonApiData KubeJsonApiDataFor KubeJsonApiObjectMetadata KubeObject KubeObjectMetadata KubeObjectStoreLoadAllParams KubeObjectStoreLoadingParams KubeObjectStoreSubscribeParams KubeStatus KubeStatusData LimitRange Namespace NamespaceScopedMetadata NetworkPolicy Node OwnerReference PersistentVolume PersistentVolumeClaim Pod PodDisruptionBudget PriorityClass ReplicaSet ResourceQuota Role RoleBinding Secret Service ServiceAccount StatefulSet StorageClass","title":"References"},{"location":"extensions/api/modules/Renderer.K8sApi/#enumerations","text":"KubeObjectStatusLevel","title":"Enumerations"},{"location":"extensions/api/modules/Renderer.K8sApi/#classes","text":"CRDResourceStore CRDStore ConfigMapsStore CronJobStore DaemonSetStore DeploymentStore EndpointStore EventStore HPAStore IngressClassStore IngressStore JobStore KubeObjectStore LimitRangesStore NamespaceStore NetworkPolicyStore NodesStore PersistentVolumesStore PodDisruptionBudgetsStore PodsStore PriorityClassStoreStore ReplicaSetStore ResourceQuotasStore ResourceStack RoleBindingsStore RolesStore SecretsStore ServiceAccountsStore ServiceStore StatefulSetStore StorageClassStore VerticalPodAutoscalerStore VolumeClaimStore","title":"Classes"},{"location":"extensions/api/modules/Renderer.K8sApi/#interfaces","text":"IKubeApiCluster IgnoredKubeApiOptions KubeObjectStatus MetricData MetricResult RequestMetricsParams","title":"Interfaces"},{"location":"extensions/api/modules/Renderer.K8sApi/#type-aliases","text":"DeploymentApi IngressApi KubeApi KubeJsonApi NodesApi PersistentVolumeClaimsApi PodsApi RequestMetrics","title":"Type Aliases"},{"location":"extensions/api/modules/Renderer.K8sApi/#variables","text":"DeploymentApi IngressApi KubeApi KubeJsonApi NodesApi PersistentVolumeClaimsApi PodsApi apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi hpaApi ingressApi jobApi limitRangeApi namespacesApi networkPolicyApi nodesApi pcApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi vpaApi","title":"Variables"},{"location":"extensions/api/modules/Renderer.K8sApi/#functions","text":"createResourceStack forCluster forRemoteCluster isAllowedResource requestMetrics","title":"Functions"},{"location":"extensions/api/modules/Renderer.K8sApi/#references_1","text":"","title":"References"},{"location":"extensions/api/modules/Renderer.K8sApi/#basekubejsonapiobjectmetadata","text":"Re-exports BaseKubeJsonApiObjectMetadata","title":"BaseKubeJsonApiObjectMetadata"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterrole","text":"Re-exports ClusterRole","title":"ClusterRole"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterrolebinding","text":"Re-exports ClusterRoleBinding","title":"ClusterRoleBinding"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterscopedmetadata","text":"Re-exports ClusterScopedMetadata","title":"ClusterScopedMetadata"},{"location":"extensions/api/modules/Renderer.K8sApi/#configmap","text":"Re-exports ConfigMap","title":"ConfigMap"},{"location":"extensions/api/modules/Renderer.K8sApi/#cronjob","text":"Re-exports CronJob","title":"CronJob"},{"location":"extensions/api/modules/Renderer.K8sApi/#customresourcedefinition","text":"Re-exports CustomResourceDefinition","title":"CustomResourceDefinition"},{"location":"extensions/api/modules/Renderer.K8sApi/#daemonset","text":"Re-exports DaemonSet","title":"DaemonSet"},{"location":"extensions/api/modules/Renderer.K8sApi/#deployment","text":"Re-exports Deployment","title":"Deployment"},{"location":"extensions/api/modules/Renderer.K8sApi/#endpoint","text":"Re-exports Endpoint","title":"Endpoint"},{"location":"extensions/api/modules/Renderer.K8sApi/#horizontalpodautoscaler","text":"Re-exports HorizontalPodAutoscaler","title":"HorizontalPodAutoscaler"},{"location":"extensions/api/modules/Renderer.K8sApi/#horizontalpodautoscalerstore","text":"Renames and re-exports HPAStore","title":"HorizontalPodAutoscalerStore"},{"location":"extensions/api/modules/Renderer.K8sApi/#ilocalkubeapiconfig","text":"Re-exports ILocalKubeApiConfig","title":"ILocalKubeApiConfig"},{"location":"extensions/api/modules/Renderer.K8sApi/#ipodcontainer","text":"Re-exports IPodContainer","title":"IPodContainer"},{"location":"extensions/api/modules/Renderer.K8sApi/#ipodcontainerstatus","text":"Re-exports IPodContainerStatus","title":"IPodContainerStatus"},{"location":"extensions/api/modules/Renderer.K8sApi/#iremotekubeapiconfig","text":"Re-exports IRemoteKubeApiConfig","title":"IRemoteKubeApiConfig"},{"location":"extensions/api/modules/Renderer.K8sApi/#isecretref","text":"Re-exports ISecretRef","title":"ISecretRef"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingress","text":"Re-exports Ingress","title":"Ingress"},{"location":"extensions/api/modules/Renderer.K8sApi/#job","text":"Re-exports Job","title":"Job"},{"location":"extensions/api/modules/Renderer.K8sApi/#jsonpatch","text":"Re-exports JsonPatch","title":"JsonPatch"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeevent","text":"Re-exports KubeEvent","title":"KubeEvent"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapidata","text":"Re-exports KubeJsonApiData","title":"KubeJsonApiData"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapidatafor","text":"Re-exports KubeJsonApiDataFor","title":"KubeJsonApiDataFor"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapiobjectmetadata","text":"Re-exports KubeJsonApiObjectMetadata","title":"KubeJsonApiObjectMetadata"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobject","text":"Re-exports KubeObject","title":"KubeObject"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectmetadata","text":"Re-exports KubeObjectMetadata","title":"KubeObjectMetadata"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstoreloadallparams","text":"Re-exports KubeObjectStoreLoadAllParams","title":"KubeObjectStoreLoadAllParams"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstoreloadingparams","text":"Re-exports KubeObjectStoreLoadingParams","title":"KubeObjectStoreLoadingParams"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeobjectstoresubscribeparams","text":"Re-exports KubeObjectStoreSubscribeParams","title":"KubeObjectStoreSubscribeParams"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubestatus","text":"Re-exports KubeStatus","title":"KubeStatus"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubestatusdata","text":"Re-exports KubeStatusData","title":"KubeStatusData"},{"location":"extensions/api/modules/Renderer.K8sApi/#limitrange","text":"Re-exports LimitRange","title":"LimitRange"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespace","text":"Re-exports Namespace","title":"Namespace"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespacescopedmetadata","text":"Re-exports NamespaceScopedMetadata","title":"NamespaceScopedMetadata"},{"location":"extensions/api/modules/Renderer.K8sApi/#networkpolicy","text":"Re-exports NetworkPolicy","title":"NetworkPolicy"},{"location":"extensions/api/modules/Renderer.K8sApi/#node","text":"Re-exports Node","title":"Node"},{"location":"extensions/api/modules/Renderer.K8sApi/#ownerreference","text":"Re-exports OwnerReference","title":"OwnerReference"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolume","text":"Re-exports PersistentVolume","title":"PersistentVolume"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeclaim","text":"Re-exports PersistentVolumeClaim","title":"PersistentVolumeClaim"},{"location":"extensions/api/modules/Renderer.K8sApi/#pod","text":"Re-exports Pod","title":"Pod"},{"location":"extensions/api/modules/Renderer.K8sApi/#poddisruptionbudget","text":"Re-exports PodDisruptionBudget","title":"PodDisruptionBudget"},{"location":"extensions/api/modules/Renderer.K8sApi/#priorityclass","text":"Re-exports PriorityClass","title":"PriorityClass"},{"location":"extensions/api/modules/Renderer.K8sApi/#replicaset","text":"Re-exports ReplicaSet","title":"ReplicaSet"},{"location":"extensions/api/modules/Renderer.K8sApi/#resourcequota","text":"Re-exports ResourceQuota","title":"ResourceQuota"},{"location":"extensions/api/modules/Renderer.K8sApi/#role","text":"Re-exports Role","title":"Role"},{"location":"extensions/api/modules/Renderer.K8sApi/#rolebinding","text":"Re-exports RoleBinding","title":"RoleBinding"},{"location":"extensions/api/modules/Renderer.K8sApi/#secret","text":"Re-exports Secret","title":"Secret"},{"location":"extensions/api/modules/Renderer.K8sApi/#service","text":"Re-exports Service","title":"Service"},{"location":"extensions/api/modules/Renderer.K8sApi/#serviceaccount","text":"Re-exports ServiceAccount","title":"ServiceAccount"},{"location":"extensions/api/modules/Renderer.K8sApi/#statefulset","text":"Re-exports StatefulSet","title":"StatefulSet"},{"location":"extensions/api/modules/Renderer.K8sApi/#storageclass","text":"Re-exports StorageClass","title":"StorageClass"},{"location":"extensions/api/modules/Renderer.K8sApi/#type-aliases_1","text":"","title":"Type Aliases"},{"location":"extensions/api/modules/Renderer.K8sApi/#deploymentapi","text":"\u01ac DeploymentApi : InternalDeploymentApi","title":"DeploymentApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingressapi","text":"\u01ac IngressApi : InternalIngressApi","title":"IngressApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeapi","text":"\u01ac KubeApi < Object , Data >: InternalKubeApi < Object , Data >","title":"KubeApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapi","text":"\u01ac KubeJsonApi : InternalKubeJsonApi","title":"KubeJsonApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#nodesapi","text":"\u01ac NodesApi : NodeApi","title":"NodesApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeclaimsapi","text":"\u01ac PersistentVolumeClaimsApi : PersistentVolumeClaimApi","title":"PersistentVolumeClaimsApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#podsapi","text":"\u01ac PodsApi : PodApi","title":"PodsApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#requestmetrics","text":"\u01ac RequestMetrics : ReturnType ","title":"RequestMetrics"},{"location":"extensions/api/modules/Renderer.K8sApi/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Renderer.K8sApi/#deploymentapi_1","text":"\u2022 DeploymentApi : ( opts? : DerivedKubeApiOptions ) => DeploymentApi","title":"DeploymentApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingressapi_1","text":"\u2022 IngressApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => IngressApi","title":"IngressApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubeapi_1","text":"\u2022 KubeApi : ( opts : KubeApiOptions < Object_1 , Data >) => KubeApi < Object_1 , Data >","title":"KubeApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#kubejsonapi_1","text":"\u2022 KubeJsonApi : ( config : JsonApiConfig , reqInit? : RequestInit ) => KubeJsonApi & { forCluster : CreateKubeJsonApiForCluster }","title":"KubeJsonApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#nodesapi_1","text":"\u2022 NodesApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => NodeApi","title":"NodesApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeclaimsapi_1","text":"\u2022 PersistentVolumeClaimsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PersistentVolumeClaimApi","title":"PersistentVolumeClaimsApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#podsapi_1","text":"\u2022 PodsApi : ( opts? : DerivedKubeApiOptions & IgnoredKubeApiOptions ) => PodApi","title":"PodsApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#apimanager","text":"\u2022 Const apiManager : ApiManager","title":"apiManager"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterroleapi","text":"\u2022 Const clusterRoleApi : ClusterRoleApi","title":"clusterRoleApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#clusterrolebindingapi","text":"\u2022 Const clusterRoleBindingApi : ClusterRoleBindingApi","title":"clusterRoleBindingApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#configmapapi","text":"\u2022 Const configMapApi : ConfigMapApi","title":"configMapApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#crdapi","text":"\u2022 Const crdApi : CustomResourceDefinitionApi","title":"crdApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#cronjobapi","text":"\u2022 Const cronJobApi : CronJobApi","title":"cronJobApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#daemonsetapi","text":"\u2022 Const daemonSetApi : DaemonSetApi","title":"daemonSetApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#deploymentapi_2","text":"\u2022 Const deploymentApi : DeploymentApi","title":"deploymentApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#endpointapi","text":"\u2022 Const endpointApi : EndpointsApi","title":"endpointApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#eventapi","text":"\u2022 Const eventApi : KubeEventApi","title":"eventApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#hpaapi","text":"\u2022 Const hpaApi : HorizontalPodAutoscalerApi","title":"hpaApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#ingressapi_2","text":"\u2022 Const ingressApi : IngressApi","title":"ingressApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#jobapi","text":"\u2022 Const jobApi : JobApi","title":"jobApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#limitrangeapi","text":"\u2022 Const limitRangeApi : LimitRangeApi","title":"limitRangeApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#namespacesapi","text":"\u2022 Const namespacesApi : NamespaceApi","title":"namespacesApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#networkpolicyapi","text":"\u2022 Const networkPolicyApi : NetworkPolicyApi","title":"networkPolicyApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#nodesapi_2","text":"\u2022 Const nodesApi : NodeApi","title":"nodesApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#pcapi","text":"\u2022 Const pcApi : PriorityClassApi","title":"pcApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#pdbapi","text":"\u2022 Const pdbApi : PodDisruptionBudgetApi","title":"pdbApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#persistentvolumeapi","text":"\u2022 Const persistentVolumeApi : PersistentVolumeApi","title":"persistentVolumeApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#podsapi_2","text":"\u2022 Const podsApi : PodApi","title":"podsApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#pvcapi","text":"\u2022 Const pvcApi : PersistentVolumeClaimApi","title":"pvcApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#replicasetapi","text":"\u2022 Const replicaSetApi : ReplicaSetApi","title":"replicaSetApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#resourcequotaapi","text":"\u2022 Const resourceQuotaApi : ResourceQuotaApi","title":"resourceQuotaApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#roleapi","text":"\u2022 Const roleApi : RoleApi","title":"roleApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#rolebindingapi","text":"\u2022 Const roleBindingApi : RoleBindingApi","title":"roleBindingApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#secretsapi","text":"\u2022 Const secretsApi : SecretApi","title":"secretsApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#serviceaccountsapi","text":"\u2022 Const serviceAccountsApi : ServiceAccountApi","title":"serviceAccountsApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#serviceapi","text":"\u2022 Const serviceApi : ServiceApi","title":"serviceApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#statefulsetapi","text":"\u2022 Const statefulSetApi : StatefulSetApi","title":"statefulSetApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#storageclassapi","text":"\u2022 Const storageClassApi : StorageClassApi","title":"storageClassApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#vpaapi","text":"\u2022 Const vpaApi : VerticalPodAutoscalerApi","title":"vpaApi"},{"location":"extensions/api/modules/Renderer.K8sApi/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Renderer.K8sApi/#createresourcestack","text":"\u25b8 createResourceStack ( cluster , name ): ResourceApplyingStack","title":"createResourceStack"},{"location":"extensions/api/modules/Renderer.K8sApi/#forcluster","text":"\u25b8 forCluster < Object , Api , Data >( cluster , kubeClass , apiClass ): Api","title":"forCluster"},{"location":"extensions/api/modules/Renderer.K8sApi/#forremotecluster","text":"\u25b8 forRemoteCluster < Object , Api , Data >( config , kubeClass , apiClass ): Api","title":"forRemoteCluster"},{"location":"extensions/api/modules/Renderer.K8sApi/#isallowedresource","text":"\u25b8 isAllowedResource ( resources ): boolean","title":"isAllowedResource"},{"location":"extensions/api/modules/Renderer.K8sApi/#requestmetrics_1","text":"\u25b8 requestMetrics ( query , params? ): Promise < MetricData >","title":"requestMetrics"},{"location":"extensions/api/modules/Renderer.Navigation/","text":"Namespace: Navigation # Renderer .Navigation Table of contents # Classes # PageParam Interfaces # PageParamInit URLParams Functions # createPageParam getDetailsUrl hideDetails isActiveRoute navigate showDetails Functions # createPageParam # \u25b8 createPageParam < Value >( init ): PageParam < Value > Type parameters # Name Type Value string Parameters # Name Type init PageParamInit < Value > Returns # PageParam < Value > getDetailsUrl # \u25b8 getDetailsUrl ( selfLink , resetSelected? , mergeGlobals? ): string Parameters # Name Type selfLink string resetSelected? boolean mergeGlobals? boolean Returns # string hideDetails # \u25b8 hideDetails (): void Returns # void isActiveRoute # \u25b8 isActiveRoute ( route ): boolean Parameters # Name Type route string | string [] | RouteProps < string , {}> Returns # boolean navigate # \u25b8 navigate ( location ): void Parameters # Name Type location LocationDescriptor < unknown > Returns # void showDetails # \u25b8 showDetails ( selfLink , resetSelected? ): void Default resetSelected true Parameters # 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) Returns # void","title":"Namespace: Navigation"},{"location":"extensions/api/modules/Renderer.Navigation/#namespace-navigation","text":"Renderer .Navigation","title":"Namespace: Navigation"},{"location":"extensions/api/modules/Renderer.Navigation/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Renderer.Navigation/#classes","text":"PageParam","title":"Classes"},{"location":"extensions/api/modules/Renderer.Navigation/#interfaces","text":"PageParamInit URLParams","title":"Interfaces"},{"location":"extensions/api/modules/Renderer.Navigation/#functions","text":"createPageParam getDetailsUrl hideDetails isActiveRoute navigate showDetails","title":"Functions"},{"location":"extensions/api/modules/Renderer.Navigation/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Renderer.Navigation/#createpageparam","text":"\u25b8 createPageParam < Value >( init ): PageParam < Value >","title":"createPageParam"},{"location":"extensions/api/modules/Renderer.Navigation/#getdetailsurl","text":"\u25b8 getDetailsUrl ( selfLink , resetSelected? , mergeGlobals? ): string","title":"getDetailsUrl"},{"location":"extensions/api/modules/Renderer.Navigation/#hidedetails","text":"\u25b8 hideDetails (): void","title":"hideDetails"},{"location":"extensions/api/modules/Renderer.Navigation/#isactiveroute","text":"\u25b8 isActiveRoute ( route ): boolean","title":"isActiveRoute"},{"location":"extensions/api/modules/Renderer.Navigation/#navigate","text":"\u25b8 navigate ( location ): void","title":"navigate"},{"location":"extensions/api/modules/Renderer.Navigation/#showdetails","text":"\u25b8 showDetails ( selfLink , resetSelected? ): void Default resetSelected true","title":"showDetails"},{"location":"extensions/api/modules/Renderer.Theme/","text":"Namespace: Theme # Renderer .Theme Table of contents # Interfaces # LensTheme Variables # activeTheme Functions # getActiveTheme Variables # activeTheme # \u2022 Const activeTheme : IComputedValue Functions # getActiveTheme # \u25b8 getActiveTheme (): ReadonlyObjectDeep Deprecated This hides the reactivity of active theme, use activeTheme instead Returns # ReadonlyObjectDeep","title":"Namespace: Theme"},{"location":"extensions/api/modules/Renderer.Theme/#namespace-theme","text":"Renderer .Theme","title":"Namespace: Theme"},{"location":"extensions/api/modules/Renderer.Theme/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Renderer.Theme/#interfaces","text":"LensTheme","title":"Interfaces"},{"location":"extensions/api/modules/Renderer.Theme/#variables","text":"activeTheme","title":"Variables"},{"location":"extensions/api/modules/Renderer.Theme/#functions","text":"getActiveTheme","title":"Functions"},{"location":"extensions/api/modules/Renderer.Theme/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/Renderer.Theme/#activetheme","text":"\u2022 Const activeTheme : IComputedValue","title":"activeTheme"},{"location":"extensions/api/modules/Renderer.Theme/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/Renderer.Theme/#getactivetheme","text":"\u25b8 getActiveTheme (): ReadonlyObjectDeep Deprecated This hides the reactivity of active theme, use activeTheme instead","title":"getActiveTheme"},{"location":"extensions/api/modules/Renderer/","text":"Namespace: Renderer # Table of contents # Namespaces # Catalog Component K8sApi Navigation Theme Classes # Ipc LensExtension","title":"Namespace: Renderer"},{"location":"extensions/api/modules/Renderer/#namespace-renderer","text":"","title":"Namespace: Renderer"},{"location":"extensions/api/modules/Renderer/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/Renderer/#namespaces","text":"Catalog Component K8sApi Navigation Theme","title":"Namespaces"},{"location":"extensions/api/modules/Renderer/#classes","text":"Ipc LensExtension","title":"Classes"},{"location":"extensions/capabilities/","text":"","title":"Index"},{"location":"extensions/capabilities/common-capabilities/","text":"Common Capabilities # 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. Main Extension # 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. Activate # This extension can register a custom callback that is executed when an extension is activated (started). import { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { async onActivate () { console . log ( \"hello world\" ) } } Deactivate # This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { async onDeactivate () { console . log ( \"bye bye\" ) } } Menus # This extension can register custom app and tray menus that will be displayed on OS native menus. Example: import { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Example item\" , click () { Main . Navigation . navigate ( \"https://k8slens.dev\" ); } } ] trayMenus = [ { label : \"My links\" , submenu : [ { label : \"Lens\" , click () { Main . Navigation . navigate ( \"https://k8slens.dev\" ); } }, { type : \"separator\" }, { label : \"Lens Github\" , click () { Main . Navigation . navigate ( \"https://github.com/lensapp/lens\" ); } } ] } ] } Renderer Extension # 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 . Activate # This extension can register a custom callback that is executed when an extension is activated (started). import { Renderer } from \"@k8slens/extensions\" export default class ExampleExtension extends Renderer . LensExtension { async onActivate () { console . log ( \"hello world\" ) } } Deactivate # This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { Renderer } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Renderer . LensExtension { async onDeactivate () { console . log ( \"bye bye\" ) } } Global Pages # 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\" import { Renderer } from \"@k8slens/extensions\" import { ExamplePage } from \"./src/example-page\" const { Component : { Icon , } } = Renderer ; export default class ExampleRendererExtension extends Renderer . LensExtension { globalPages = [ { id : \"example\" , components : { Page : ExamplePage , } } ] globalPageMenus = [ { title : \"Example page\" , // used in icon's tooltip target : { pageId : \"example\" } components : { Icon : () => < Icon material = \"arrow\" /> , } } ] } App Preferences # This extension can register custom app preferences. It is responsible for storing a state for custom preferences. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" import { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\" import { MyCustomPreferenceHint , MyCustomPreferenceInput } from \"./src/my-custom-preference\" export default class ExampleRendererExtension extends Renderer . LensExtension { appPreferences = [ { title : \"My Custom Preference\" , components : { Hint : () => < MyCustomPreferenceHint /> , Input : () => < MyCustomPreferenceInput store = { myCustomPreferencesStore } /> } } ] } Cluster Pages # This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./src/page\" export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"extension-example\" , // optional exact : true , // optional components : { Page : () => < ExamplePage extension = { this } /> , } } ] clusterPageMenus = [ { url : \"/extension-example\" , // optional title : \"Example Extension\" , components : { Icon : ExampleIcon , } } ] } Top Bar Items # This extension can register custom components to a top bar area. import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , } } = Renderer ; export default class ExampleExtension extends Renderer . LensExtension { topBarItems = [ { components : { Item : () => ( < Icon material = \"favorite\" onClick = {() => this . navigate ( \"/example-page\" /> ) } } ] } Status Bar Items # This extension can register custom icons and text to a status bar area. import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , } } = Renderer ; export default class ExampleExtension extends Renderer . LensExtension { statusBarItems = [ { components : { Item : () => ( < div className = \"flex align-center gaps hover-highlight\" onClick = {() => this . navigate ( \"/example-page\" )} > < Icon material = \"favorite\" /> < /div> ) } } ] } Kubernetes Workloads Overview Items # This extension can register custom workloads overview items. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomWorkloadsOverviewItem } from \"./src/custom-workloads-overview-item\" export default class ExampleExtension extends Renderer . LensExtension { kubeWorkloadsOverviewItems = [ { components : { Details : () => < CustomWorkloadsOverviewItem /> } } ] } Kubernetes Object Menu Items # This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomMenuItem , CustomMenuItemProps } from \"./src/custom-menu-item\" export default class ExampleExtension extends Renderer . LensExtension { kubeObjectMenuItems = [ { kind : \"Node\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : CustomMenuItemProps ) => < CustomMenuItem {... props } /> } } ] } Kubernetes Object Details # This extension can register custom details (content) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomKindDetails , CustomKindDetailsProps } from \"./src/custom-kind-details\" export default class ExampleExtension extends Renderer . LensExtension { kubeObjectDetailItems = [ { kind : \"CustomKind\" , apiVersions : [ \"custom.acme.org/v1\" ], components : { Details : ( props : CustomKindDetailsProps ) => < CustomKindDetails {... props } /> } } ] }","title":"Common Capabilities"},{"location":"extensions/capabilities/common-capabilities/#common-capabilities","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.","title":"Common Capabilities"},{"location":"extensions/capabilities/common-capabilities/#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.","title":"Main Extension"},{"location":"extensions/capabilities/common-capabilities/#activate","text":"This extension can register a custom callback that is executed when an extension is activated (started). import { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { async onActivate () { console . log ( \"hello world\" ) } }","title":"Activate"},{"location":"extensions/capabilities/common-capabilities/#deactivate","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { Main } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Main . LensExtension { async onDeactivate () { console . log ( \"bye bye\" ) } }","title":"Deactivate"},{"location":"extensions/capabilities/common-capabilities/#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\" export default class ExampleMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Example item\" , click () { Main . Navigation . navigate ( \"https://k8slens.dev\" ); } } ] trayMenus = [ { label : \"My links\" , submenu : [ { label : \"Lens\" , click () { Main . Navigation . navigate ( \"https://k8slens.dev\" ); } }, { type : \"separator\" }, { label : \"Lens Github\" , click () { Main . Navigation . navigate ( \"https://github.com/lensapp/lens\" ); } } ] } ] }","title":"Menus"},{"location":"extensions/capabilities/common-capabilities/#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 .","title":"Renderer Extension"},{"location":"extensions/capabilities/common-capabilities/#activate_1","text":"This extension can register a custom callback that is executed when an extension is activated (started). import { Renderer } from \"@k8slens/extensions\" export default class ExampleExtension extends Renderer . LensExtension { async onActivate () { console . log ( \"hello world\" ) } }","title":"Activate"},{"location":"extensions/capabilities/common-capabilities/#deactivate_1","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { Renderer } from \"@k8slens/extensions\" export default class ExampleMainExtension extends Renderer . LensExtension { async onDeactivate () { console . log ( \"bye bye\" ) } }","title":"Deactivate"},{"location":"extensions/capabilities/common-capabilities/#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\" import { Renderer } from \"@k8slens/extensions\" import { ExamplePage } from \"./src/example-page\" const { Component : { Icon , } } = Renderer ; export default class ExampleRendererExtension extends Renderer . LensExtension { globalPages = [ { id : \"example\" , components : { Page : ExamplePage , } } ] globalPageMenus = [ { title : \"Example page\" , // used in icon's tooltip target : { pageId : \"example\" } components : { Icon : () => < Icon material = \"arrow\" /> , } } ] }","title":"Global Pages"},{"location":"extensions/capabilities/common-capabilities/#app-preferences","text":"This extension can register custom app preferences. It is responsible for storing a state for custom preferences. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" import { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\" import { MyCustomPreferenceHint , MyCustomPreferenceInput } from \"./src/my-custom-preference\" export default class ExampleRendererExtension extends Renderer . LensExtension { appPreferences = [ { title : \"My Custom Preference\" , components : { Hint : () => < MyCustomPreferenceHint /> , Input : () => < MyCustomPreferenceInput store = { myCustomPreferencesStore } /> } } ] }","title":"App Preferences"},{"location":"extensions/capabilities/common-capabilities/#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\" import { Renderer } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./src/page\" export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"extension-example\" , // optional exact : true , // optional components : { Page : () => < ExamplePage extension = { this } /> , } } ] clusterPageMenus = [ { url : \"/extension-example\" , // optional title : \"Example Extension\" , components : { Icon : ExampleIcon , } } ] }","title":"Cluster Pages"},{"location":"extensions/capabilities/common-capabilities/#top-bar-items","text":"This extension can register custom components to a top bar area. import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , } } = Renderer ; export default class ExampleExtension extends Renderer . LensExtension { topBarItems = [ { components : { Item : () => ( < Icon material = \"favorite\" onClick = {() => this . navigate ( \"/example-page\" /> ) } } ] }","title":"Top Bar Items"},{"location":"extensions/capabilities/common-capabilities/#status-bar-items","text":"This extension can register custom icons and text to a status bar area. import React from \"react\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , } } = Renderer ; export default class ExampleExtension extends Renderer . LensExtension { statusBarItems = [ { components : { Item : () => ( < div className = \"flex align-center gaps hover-highlight\" onClick = {() => this . navigate ( \"/example-page\" )} > < Icon material = \"favorite\" /> < /div> ) } } ] }","title":"Status Bar Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-workloads-overview-items","text":"This extension can register custom workloads overview items. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomWorkloadsOverviewItem } from \"./src/custom-workloads-overview-item\" export default class ExampleExtension extends Renderer . LensExtension { kubeWorkloadsOverviewItems = [ { components : { Details : () => < CustomWorkloadsOverviewItem /> } } ] }","title":"Kubernetes Workloads Overview Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-menu-items","text":"This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomMenuItem , CustomMenuItemProps } from \"./src/custom-menu-item\" export default class ExampleExtension extends Renderer . LensExtension { kubeObjectMenuItems = [ { kind : \"Node\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : CustomMenuItemProps ) => < CustomMenuItem {... props } /> } } ] }","title":"Kubernetes Object Menu Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-details","text":"This extension can register custom details (content) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { Renderer } from \"@k8slens/extensions\" ; import { CustomKindDetails , CustomKindDetailsProps } from \"./src/custom-kind-details\" export default class ExampleExtension extends Renderer . LensExtension { kubeObjectDetailItems = [ { kind : \"CustomKind\" , apiVersions : [ \"custom.acme.org/v1\" ], components : { Details : ( props : CustomKindDetailsProps ) => < CustomKindDetails {... props } /> } } ] }","title":"Kubernetes Object Details"},{"location":"extensions/capabilities/styling/","text":"Styling an Extension # 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. Layout # 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 { display : flex ; flex-direction : column ; align-items : center ; } However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS. Layout Variables # 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 ; --padding : var ( --unit ); --margin : var ( --unit ); --border-radius : 3px ; These variables are intended to set consistent margins and paddings across components. For example: . status { padding-left : calc ( var ( --padding ) * 2 ); border-radius : var ( --border-radius ); } Themes # Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark. Theme Variables # 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 ; --font-monospace : Lucida Console , Monaco , Consolas , monospace ; --font-size-small : calc ( 1 . 5 * var ( --unit )); --font-size : calc ( 1 . 75 * var ( --unit )); --font-size-big : calc ( 2 * var ( --unit )); --font-weight-thin : 300 ; --font-weight-normal : 400 ; --font-weight-bold : 500 ; as well as in the theme modules : --blue: #3d90ce; --magenta: #c93dce; --golden: #ffc63d; --halfGray: #87909c80; --primary: #3d90ce; --textColorPrimary: #555555; --textColorSecondary: #51575d; --textColorAccent: #333333; --borderColor: #c9cfd3; --borderFaintColor: #dfdfdf; --mainBackground: #f1f1f1; --contentColor: #ffffff; --layoutBackground: #e8e8e8; --layoutTabsBackground: #f8f8f8; --layoutTabsActiveColor: #333333; --layoutTabsLineColor: #87909c80; ... These variables can be used in the following form: var(--magenta) . For example: . status { font-size : var ( --font-size-small ); background-color : var ( --colorSuccess ); } Theme Switching # When the light theme is active, the element gets a \"theme-light\" class, or: . 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\" import { observer } from \"mobx-react\" import { Renderer } from \"@k8slens/extensions\" ; @ observer export class SupportPage extends React . Component { render () { return ( < div className = \"SupportPage\" > < h1 > Active theme is { Renderer . Theme . getActiveTheme (). name } < /h1> < /div> ); } } 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. Injected Styles # Every extension is affected by the list of default global styles defined in app.scss . These are basic browser resets and element styles, including: setting the box-sizing property for every element default text and background colors default font sizes basic heading (h1, h2, etc) formatting custom scrollbar styling Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy. CSS-in-JS # If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows: const Container = styled . div (() => ({ backgroundColor : 'var(--mainBackground)' })); Examples # You can explore samples for each styling technique that you can use for extensions: Styling with Sass Styling with Emotion Styling with CSS Modules","title":"Styling"},{"location":"extensions/capabilities/styling/#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.","title":"Styling an Extension"},{"location":"extensions/capabilities/styling/#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 { display : flex ; flex-direction : column ; align-items : center ; } However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS.","title":"Layout"},{"location":"extensions/capabilities/styling/#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 ; --padding : var ( --unit ); --margin : var ( --unit ); --border-radius : 3px ; These variables are intended to set consistent margins and paddings across components. For example: . status { padding-left : calc ( var ( --padding ) * 2 ); border-radius : var ( --border-radius ); }","title":"Layout Variables"},{"location":"extensions/capabilities/styling/#themes","text":"Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark.","title":"Themes"},{"location":"extensions/capabilities/styling/#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 ; --font-monospace : Lucida Console , Monaco , Consolas , monospace ; --font-size-small : calc ( 1 . 5 * var ( --unit )); --font-size : calc ( 1 . 75 * var ( --unit )); --font-size-big : calc ( 2 * var ( --unit )); --font-weight-thin : 300 ; --font-weight-normal : 400 ; --font-weight-bold : 500 ; as well as in the theme modules : --blue: #3d90ce; --magenta: #c93dce; --golden: #ffc63d; --halfGray: #87909c80; --primary: #3d90ce; --textColorPrimary: #555555; --textColorSecondary: #51575d; --textColorAccent: #333333; --borderColor: #c9cfd3; --borderFaintColor: #dfdfdf; --mainBackground: #f1f1f1; --contentColor: #ffffff; --layoutBackground: #e8e8e8; --layoutTabsBackground: #f8f8f8; --layoutTabsActiveColor: #333333; --layoutTabsLineColor: #87909c80; ... These variables can be used in the following form: var(--magenta) . For example: . status { font-size : var ( --font-size-small ); background-color : var ( --colorSuccess ); }","title":"Theme Variables"},{"location":"extensions/capabilities/styling/#theme-switching","text":"When the light theme is active, the element gets a \"theme-light\" class, or: . 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\" import { observer } from \"mobx-react\" import { Renderer } from \"@k8slens/extensions\" ; @ observer export class SupportPage extends React . Component { render () { return ( < div className = \"SupportPage\" > < h1 > Active theme is { Renderer . Theme . getActiveTheme (). name } < /h1> < /div> ); } } 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.","title":"Theme Switching"},{"location":"extensions/capabilities/styling/#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: setting the box-sizing property for every element default text and background colors default font sizes basic heading (h1, h2, etc) formatting custom scrollbar styling Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy.","title":"Injected Styles"},{"location":"extensions/capabilities/styling/#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 (() => ({ backgroundColor : 'var(--mainBackground)' }));","title":"CSS-in-JS"},{"location":"extensions/capabilities/styling/#examples","text":"You can explore samples for each styling technique that you can use for extensions: Styling with Sass Styling with Emotion Styling with CSS Modules","title":"Examples"},{"location":"extensions/get-started/anatomy/","text":"Extension Anatomy # 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: Implements onActivate() and outputs a message to the console. Implements onDeactivate() and outputs a message to the console. Registers 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. Extension File Structure # . \u251c\u2500\u2500 .gitignore // Ignore build output and node_modules \u251c\u2500\u2500 Makefile // Config for build tasks that compiles the extension \u251c\u2500\u2500 README.md // Readable description of your extension's functionality \u251c\u2500\u2500 src \u2502 \u2514\u2500\u2500 page.tsx // Extension's additional source code \u251c\u2500\u2500 main.ts // Source code for extension's main entrypoint \u251c\u2500\u2500 package.json // Extension manifest and dependencies \u251c\u2500\u2500 renderer.tsx // Source code for extension's renderer entrypoint \u251c\u2500\u2500 tsconfig.json // TypeScript configuration \u251c\u2500\u2500 webpack.config.js // Webpack configuration 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. Extension Manifest # 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 @/ 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. { \"name\" : \"helloworld-sample\" , \"publisher\" : \"lens-samples\" , \"version\" : \"0.0.1\" , \"description\" : \"Lens helloworld-sample\" , \"license\" : \"MIT\" , \"homepage\" : \"https://github.com/lensapp/lens-extension-samples\" , \"engines\" : { \"node\" : \"^16.14.2\" , \"lens\" : \"5.4\" }, \"main\" : \"dist/main.js\" , \"renderer\" : \"dist/renderer.js\" , \"scripts\" : { \"build\" : \"webpack --config webpack.config.js\" , \"dev\" : \"npm run build --watch\" }, \"dependencies\" : { \"react-open-doodles\" : \"^1.0.5\" }, \"devDependencies\" : { \"@k8slens/extensions\" : \"^5.4.6\" , \"ts-loader\" : \"^8.0.4\" , \"typescript\" : \"^4.5.5\" , \"@types/react\" : \"^17.0.44\" , \"@types/node\" : \"^16.14.2\" , \"webpack\" : \"^4.44.2\" , \"webpack-cli\" : \"^3.3.11\" } } Webpack configuration # The following webpack externals are provided by Lens and must be used (when available) to make sure that the versions used are in sync. Package webpack external syntax Lens versions Available in Main Available in Renderer 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. { ... \"externals\" : [ ... { \"mobx\" : \"var global.Mobx\" \"mobx-react\" : \"var global.MobxReact\" \"react\" : \"var global.React\" \"react-router\" : \"var global.ReactRouter\" \"react-router-dom\" : \"var global.ReactRouterDom\" \"react-dom\" : \"var global.ReactDOM\" } ] } Extension Entry Files # 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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"extension-example\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; } 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.","title":"Extension Anatomy"},{"location":"extensions/get-started/anatomy/#extension-anatomy","text":"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: Implements onActivate() and outputs a message to the console. Implements onDeactivate() and outputs a message to the console. Registers 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.","title":"Extension Anatomy"},{"location":"extensions/get-started/anatomy/#extension-file-structure","text":". \u251c\u2500\u2500 .gitignore // Ignore build output and node_modules \u251c\u2500\u2500 Makefile // Config for build tasks that compiles the extension \u251c\u2500\u2500 README.md // Readable description of your extension's functionality \u251c\u2500\u2500 src \u2502 \u2514\u2500\u2500 page.tsx // Extension's additional source code \u251c\u2500\u2500 main.ts // Source code for extension's main entrypoint \u251c\u2500\u2500 package.json // Extension manifest and dependencies \u251c\u2500\u2500 renderer.tsx // Source code for extension's renderer entrypoint \u251c\u2500\u2500 tsconfig.json // TypeScript configuration \u251c\u2500\u2500 webpack.config.js // Webpack configuration 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.","title":"Extension File Structure"},{"location":"extensions/get-started/anatomy/#extension-manifest","text":"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 @/ 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. { \"name\" : \"helloworld-sample\" , \"publisher\" : \"lens-samples\" , \"version\" : \"0.0.1\" , \"description\" : \"Lens helloworld-sample\" , \"license\" : \"MIT\" , \"homepage\" : \"https://github.com/lensapp/lens-extension-samples\" , \"engines\" : { \"node\" : \"^16.14.2\" , \"lens\" : \"5.4\" }, \"main\" : \"dist/main.js\" , \"renderer\" : \"dist/renderer.js\" , \"scripts\" : { \"build\" : \"webpack --config webpack.config.js\" , \"dev\" : \"npm run build --watch\" }, \"dependencies\" : { \"react-open-doodles\" : \"^1.0.5\" }, \"devDependencies\" : { \"@k8slens/extensions\" : \"^5.4.6\" , \"ts-loader\" : \"^8.0.4\" , \"typescript\" : \"^4.5.5\" , \"@types/react\" : \"^17.0.44\" , \"@types/node\" : \"^16.14.2\" , \"webpack\" : \"^4.44.2\" , \"webpack-cli\" : \"^3.3.11\" } }","title":"Extension Manifest"},{"location":"extensions/get-started/anatomy/#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. Package webpack external syntax Lens versions Available in Main Available in Renderer 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. { ... \"externals\" : [ ... { \"mobx\" : \"var global.Mobx\" \"mobx-react\" : \"var global.MobxReact\" \"react\" : \"var global.React\" \"react-router\" : \"var global.ReactRouter\" \"react-router-dom\" : \"var global.ReactRouterDom\" \"react-dom\" : \"var global.ReactDOM\" } ] }","title":"Webpack configuration"},{"location":"extensions/get-started/anatomy/#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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"extension-example\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; } 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.","title":"Extension Entry Files"},{"location":"extensions/get-started/overview/","text":"Extension Development Overview # 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. Required: # Node.js Git Some sort of text editor \u2013 we recommend VSCode We use Webpack for compilation. All extension need to be at least compatible with a webpack system. Recommended: # 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.","title":"Overview"},{"location":"extensions/get-started/overview/#extension-development-overview","text":"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.","title":"Extension Development Overview"},{"location":"extensions/get-started/overview/#required","text":"Node.js Git Some sort of text editor \u2013 we recommend VSCode We use Webpack for compilation. All extension need to be at least compatible with a webpack system.","title":"Required:"},{"location":"extensions/get-started/overview/#recommended","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.","title":"Recommended:"},{"location":"extensions/get-started/wrapping-up/","text":"Wrapping Up # 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. Extension Capabilities # 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. Guides and Samples # 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. Testing and Publishing # In this section, you can learn: How to add integration tests to your extension How to publish your extension","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#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.","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#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.","title":"Extension Capabilities"},{"location":"extensions/get-started/wrapping-up/#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.","title":"Guides and Samples"},{"location":"extensions/get-started/wrapping-up/#testing-and-publishing","text":"In this section, you can learn: How to add integration tests to your extension How to publish your extension","title":"Testing and Publishing"},{"location":"extensions/get-started/your-first-extension/","text":"Your First Extension # 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. First Extension # 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. Install the Extension # To install the extension, clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git 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 . Linux & macOS # mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s lens-extension-samples/helloworld-sample helloworld-sample Windows # Create the directory that Lens will monitor for user-installed extensions: mkdir C: \\U sers \\< user> \\. k8slens \\e xtensions -force cd C: \\U sers \\< user> \\. k8slens \\e xtensions 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 \\h elloworld-sample Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\\\.k8slens\\extensions : Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\\\.k8slens\\extensions\\helloworld-sample' Build the Extension # To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build To run the npm commands, enter: cd /helloworld-sample npm install npm run build Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter: cd /helloworld-sample npm run dev 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. Develop the Extension # Finally, you'll make a change to the message that our Hello World sample extension displays: Navigate to /helloworld-sample . In page.tsx , change the message from HelloWorld! to Hello Lens Extensions . Rebuild the extension. If you used npm run dev , the extension will rebuild automatically. Reload the Lens window. Click on the Hello World page. The updated message will appear. Next Steps # 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.","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#your-first-extension","text":"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.","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#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.","title":"First Extension"},{"location":"extensions/get-started/your-first-extension/#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 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 .","title":"Install the Extension"},{"location":"extensions/get-started/your-first-extension/#linux-macos","text":"mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s lens-extension-samples/helloworld-sample helloworld-sample","title":"Linux & macOS"},{"location":"extensions/get-started/your-first-extension/#windows","text":"Create the directory that Lens will monitor for user-installed extensions: mkdir C: \\U sers \\< user> \\. k8slens \\e xtensions -force cd C: \\U sers \\< user> \\. k8slens \\e xtensions 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 \\h elloworld-sample Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\\\.k8slens\\extensions : Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\\\.k8slens\\extensions\\helloworld-sample'","title":"Windows"},{"location":"extensions/get-started/your-first-extension/#build-the-extension","text":"To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build To run the npm commands, enter: cd /helloworld-sample npm install npm run build Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter: cd /helloworld-sample npm run dev 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.","title":"Build the Extension"},{"location":"extensions/get-started/your-first-extension/#develop-the-extension","text":"Finally, you'll make a change to the message that our Hello World sample extension displays: Navigate to /helloworld-sample . In page.tsx , change the message from HelloWorld! to Hello Lens Extensions . Rebuild the extension. If you used npm run dev , the extension will rebuild automatically. Reload the Lens window. Click on the Hello World page. The updated message will appear.","title":"Develop the Extension"},{"location":"extensions/get-started/your-first-extension/#next-steps","text":"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.","title":"Next Steps"},{"location":"extensions/guides/","text":"Extension Guides # 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: Clearly commented source code. Instructions for running the sample extension. An image showing the sample extension's appearance and usage. A listing of the Extension API being used. An explanation of the concepts relevant to the Extension. Guides # Guide APIs Generate new extension project Main process extension Main.LensExtension Renderer process extension Renderer.LensExtension Resource stack (cluster feature) Extending KubernetesCluster) Stores Components KubeObjectListLayout Working with mobx Protocol Handlers Sending Data between main and renderer Catalog Entities and Categories Samples # Sample APIs hello-world LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-css-modules-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps custom-resource-page LensRendererExtension Renderer.K8sApi.KubeApi Renderer.K8sApi.KubeObjectStore Renderer.Component.KubeObjectListLayout Renderer.Component.KubeObjectDetailsProps Renderer.Component.IconProps","title":"Overview"},{"location":"extensions/guides/#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: Clearly commented source code. Instructions for running the sample extension. An image showing the sample extension's appearance and usage. A listing of the Extension API being used. An explanation of the concepts relevant to the Extension.","title":"Extension Guides"},{"location":"extensions/guides/#guides","text":"Guide APIs Generate new extension project Main process extension Main.LensExtension Renderer process extension Renderer.LensExtension Resource stack (cluster feature) Extending KubernetesCluster) Stores Components KubeObjectListLayout Working with mobx Protocol Handlers Sending Data between main and renderer Catalog Entities and Categories","title":"Guides"},{"location":"extensions/guides/#samples","text":"Sample APIs hello-world LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-css-modules-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps custom-resource-page LensRendererExtension Renderer.K8sApi.KubeApi Renderer.K8sApi.KubeObjectStore Renderer.Component.KubeObjectListLayout Renderer.Component.KubeObjectDetailsProps Renderer.Component.IconProps","title":"Samples"},{"location":"extensions/guides/anatomy/","text":"WIP #","title":"Anatomy"},{"location":"extensions/guides/anatomy/#wip","text":"","title":"WIP"},{"location":"extensions/guides/catalog/","text":"Catalog (WIP) # 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. Categories # 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: KubernetesClusters WebLinks General To register a category, call the Main.Catalog.catalogCategories.add() and Renderer.Catalog.catalogCategories.add() with instances of your class. Custom Category Views # 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\" ; function MyKubernetesClusterView ({ category , } : Common . Types . CustomCategoryViewProps ) { return < div > My view : { category . getId ()} < /div>; } export default class extends Renderer . LensExtension { customCategoryViews = [ { group : \"entity.k8slens.dev\" , kind : \"KubernetesCluster\" , priority : 10 , components : { View : MyKubernetesClusterView , }, }, ]; } 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. Styling Custom Views # By default, custom view blocks are styled with Flexbox . Some details comes from this. To set fixed height of a custom block, use max-height css rule. To set flexible height, use height . Otherwise, custom view will have height of it's contents. Entities # 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.","title":"Catalog"},{"location":"extensions/guides/catalog/#catalog-wip","text":"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.","title":"Catalog (WIP)"},{"location":"extensions/guides/catalog/#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: KubernetesClusters WebLinks General To register a category, call the Main.Catalog.catalogCategories.add() and Renderer.Catalog.catalogCategories.add() with instances of your class.","title":"Categories"},{"location":"extensions/guides/catalog/#custom-category-views","text":"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\" ; function MyKubernetesClusterView ({ category , } : Common . Types . CustomCategoryViewProps ) { return < div > My view : { category . getId ()} < /div>; } export default class extends Renderer . LensExtension { customCategoryViews = [ { group : \"entity.k8slens.dev\" , kind : \"KubernetesCluster\" , priority : 10 , components : { View : MyKubernetesClusterView , }, }, ]; } 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.","title":"Custom Category Views"},{"location":"extensions/guides/catalog/#entities","text":"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.","title":"Entities"},{"location":"extensions/guides/components/","text":"WIP #","title":"Components"},{"location":"extensions/guides/components/#wip","text":"","title":"WIP"},{"location":"extensions/guides/extending-kubernetes-cluster/","text":"Extending KubernetesCluster # Extension can specify it's own subclass of Common.Catalog.KubernetesCluster. Extension can also specify a new Category for it in the Catalog. Extending Common.Catalog.KubernetesCluster # import { Common } from \"@k8slens/extensions\" ; // The kind must be different from KubernetesCluster's kind export const kind = \"ManagedDevCluster\" ; export class ManagedDevCluster extends Common . Catalog . KubernetesCluster { public static readonly kind = kind ; public readonly kind = kind ; } Extending Common.Catalog.CatalogCategory # These custom Catalog entities can be added a new Category in the Catalog. import { Common } from \"@k8slens/extensions\" ; import { kind , ManagedDevCluster } from \"../entities/ManagedDevCluster\" ; class ManagedDevClusterCategory extends Common . Catalog . CatalogCategory { public readonly apiVersion = \"catalog.k8slens.dev/v1alpha1\" ; public readonly kind = \"CatalogCategory\" ; public metadata = { name : \"Managed Dev Clusters\" , icon : \"\" }; public spec : Common.Catalog.CatalogCategorySpec = { group : \"entity.k8slens.dev\" , versions : [ { name : \"v1alpha1\" , entityClass : ManagedDevCluster as any , }, ], names : { kind }, }; } export { ManagedDevClusterCategory }; export type { ManagedDevClusterCategory as ManagedDevClusterCategoryType }; The category needs to be registered in the onActivate() method both in main and renderer // in main's on onActivate Main . Catalog . catalogCategories . add ( new ManagedDevClusterCategory ()); // in renderer's on onActivate Renderer . Catalog . catalogCategories . add ( new ManagedDevClusterCategory ()); You can then add the entities to the Catalog as a new source: this . addCatalogSource ( \"managedDevClusters\" , this . managedDevClusters );","title":"Extending KubernetesCluster"},{"location":"extensions/guides/extending-kubernetes-cluster/#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.","title":"Extending KubernetesCluster"},{"location":"extensions/guides/extending-kubernetes-cluster/#extending-commoncatalogkubernetescluster","text":"import { Common } from \"@k8slens/extensions\" ; // The kind must be different from KubernetesCluster's kind export const kind = \"ManagedDevCluster\" ; export class ManagedDevCluster extends Common . Catalog . KubernetesCluster { public static readonly kind = kind ; public readonly kind = kind ; }","title":"Extending Common.Catalog.KubernetesCluster"},{"location":"extensions/guides/extending-kubernetes-cluster/#extending-commoncatalogcatalogcategory","text":"These custom Catalog entities can be added a new Category in the Catalog. import { Common } from \"@k8slens/extensions\" ; import { kind , ManagedDevCluster } from \"../entities/ManagedDevCluster\" ; class ManagedDevClusterCategory extends Common . Catalog . CatalogCategory { public readonly apiVersion = \"catalog.k8slens.dev/v1alpha1\" ; public readonly kind = \"CatalogCategory\" ; public metadata = { name : \"Managed Dev Clusters\" , icon : \"\" }; public spec : Common.Catalog.CatalogCategorySpec = { group : \"entity.k8slens.dev\" , versions : [ { name : \"v1alpha1\" , entityClass : ManagedDevCluster as any , }, ], names : { kind }, }; } export { ManagedDevClusterCategory }; export type { ManagedDevClusterCategory as ManagedDevClusterCategoryType }; The category needs to be registered in the onActivate() method both in main and renderer // in main's on onActivate Main . Catalog . catalogCategories . add ( new ManagedDevClusterCategory ()); // in renderer's on onActivate Renderer . Catalog . catalogCategories . add ( new ManagedDevClusterCategory ()); You can then add the entities to the Catalog as a new source: this . addCatalogSource ( \"managedDevClusters\" , this . managedDevClusters );","title":"Extending Common.Catalog.CatalogCategory"},{"location":"extensions/guides/generator/","text":"Lens Extension Generator # The Lens Extension Generator creates a directory with the necessary files for developing an extension. Installing and Getting Started with the Generator # To begin, install Yeoman and the Lens Extension Generator with the following command: npm install -g yo generator-lens-ext 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) # ? What's the name of your extension? my-first-lens-ext # ? What's the description of your extension? My hello world extension # ? What's your extension's publisher name? @my-org/my-first-lens-ext # ? Initialize a git repository? Yes # ? Install dependencies after initialization? Yes # ? Which package manager to use? yarn # ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :Users\\\\.k8slens\\extensions (windows)? Yes Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering: cd my-first-lens-ext npm start # start the webpack server in watch mode Open Lens and you will see a Hello World item in the left-side menu under Custom Resources : Developing the Extension # 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 = [ { target : { pageId : \"hello\" }, title : \"Hello Lens\" , components : { Icon : ExampleIcon , }, }, ]; 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. Debugging the Extension # To debug your extension, please see our instructions on Testing Extensions . Next Steps # 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 .","title":"Generator"},{"location":"extensions/guides/generator/#lens-extension-generator","text":"The Lens Extension Generator creates a directory with the necessary files for developing an extension.","title":"Lens Extension Generator"},{"location":"extensions/guides/generator/#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 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) # ? What's the name of your extension? my-first-lens-ext # ? What's the description of your extension? My hello world extension # ? What's your extension's publisher name? @my-org/my-first-lens-ext # ? Initialize a git repository? Yes # ? Install dependencies after initialization? Yes # ? Which package manager to use? yarn # ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :Users\\\\.k8slens\\extensions (windows)? Yes Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering: cd my-first-lens-ext npm start # start the webpack server in watch mode Open Lens and you will see a Hello World item in the left-side menu under Custom Resources :","title":"Installing and Getting Started with the Generator"},{"location":"extensions/guides/generator/#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 = [ { target : { pageId : \"hello\" }, title : \"Hello Lens\" , components : { Icon : ExampleIcon , }, }, ]; 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.","title":"Developing the Extension"},{"location":"extensions/guides/generator/#debugging-the-extension","text":"To debug your extension, please see our instructions on Testing Extensions .","title":"Debugging the Extension"},{"location":"extensions/guides/generator/#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 .","title":"Next Steps"},{"location":"extensions/guides/ipc/","text":"Inter Process Communication # 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. Types of Communication # There are two flavours of communication that are provided: Event based (IPC) Request based (RPC) Event Based or IPC # 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. Request Based or RPC # 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 . 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. Registering IPC Handlers and Listeners # The general terminology is as follows: A \"handler\" is the function that responds to a \"Request Based IPC\" event. A \"listener\" is the function that is called when a \"Event Based IPC\" event is emitted. To register either a handler or a listener, you should do something like the following: main.ts : import { Main } from \"@k8slens/extensions\" ; import { IpcMain } from \"./helpers/main\" ; export class ExampleExtensionMain extends Main . LensExtension { onActivate () { IpcMain . createInstance ( this ); } } 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\" ; export class IpcMain extends Main . Ipc { constructor ( extension : Main.LensExtension ) { super ( extension ); this . listen ( \"initialize\" , onInitialize ); } } function onInitialize ( event : Types.IpcMainEvent , id : string ) { console . log ( `starting to initialize: ${ id } ` ); } 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\" ; import { IpcRenderer } from \"./helpers/renderer\" ; export class ExampleExtensionRenderer extends Renderer . LensExtension { onActivate () { const ipc = IpcRenderer . createInstance ( this ); setTimeout (() => ipc . broadcast ( \"initialize\" , \"an-id\" ), 5000 ); } } It is also needed to create an instance to broadcast messages too. helpers/renderer.ts : import { Renderer } from \"@k8slens/extensions\" ; export class IpcRenderer extends Renderer . Ipc {} 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. Allowed Values # 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. Using Request Based Communication # If you are meaning to do a request based call from renderer , you should do const res = await IpcRenderer.getInstance().invoke(, ...)); instead.","title":"IPC"},{"location":"extensions/guides/ipc/#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.","title":"Inter Process Communication"},{"location":"extensions/guides/ipc/#types-of-communication","text":"There are two flavours of communication that are provided: Event based (IPC) Request based (RPC)","title":"Types of Communication"},{"location":"extensions/guides/ipc/#event-based-or-ipc","text":"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.","title":"Event Based or IPC"},{"location":"extensions/guides/ipc/#request-based-or-rpc","text":"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 . 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.","title":"Request Based or RPC"},{"location":"extensions/guides/ipc/#registering-ipc-handlers-and-listeners","text":"The general terminology is as follows: A \"handler\" is the function that responds to a \"Request Based IPC\" event. A \"listener\" is the function that is called when a \"Event Based IPC\" event is emitted. To register either a handler or a listener, you should do something like the following: main.ts : import { Main } from \"@k8slens/extensions\" ; import { IpcMain } from \"./helpers/main\" ; export class ExampleExtensionMain extends Main . LensExtension { onActivate () { IpcMain . createInstance ( this ); } } 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\" ; export class IpcMain extends Main . Ipc { constructor ( extension : Main.LensExtension ) { super ( extension ); this . listen ( \"initialize\" , onInitialize ); } } function onInitialize ( event : Types.IpcMainEvent , id : string ) { console . log ( `starting to initialize: ${ id } ` ); } 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\" ; import { IpcRenderer } from \"./helpers/renderer\" ; export class ExampleExtensionRenderer extends Renderer . LensExtension { onActivate () { const ipc = IpcRenderer . createInstance ( this ); setTimeout (() => ipc . broadcast ( \"initialize\" , \"an-id\" ), 5000 ); } } It is also needed to create an instance to broadcast messages too. helpers/renderer.ts : import { Renderer } from \"@k8slens/extensions\" ; export class IpcRenderer extends Renderer . Ipc {} 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.","title":"Registering IPC Handlers and Listeners"},{"location":"extensions/guides/ipc/#allowed-values","text":"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.","title":"Allowed Values"},{"location":"extensions/guides/ipc/#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(, ...)); instead.","title":"Using Request Based Communication"},{"location":"extensions/guides/kube-object-list-layout/","text":"KubeObjectListLayout Sample # 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: Register ClusterPage and ClusterPageMenu objects List Certificate Objects on the Cluster Page Customize Details Panel Register clusterPage and clusterPageMenu Objects # 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 { } 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\" ; type IconProps = Renderer . Component . IconProps ; const { Component : { Icon , }, } = Renderer ; export function CertificateIcon ( props : IconProps ) { return < Icon {... props } material = \"security\" tooltip = \"Certificates\" /> } export default class CrdSampleExtension extends Renderer . LensExtension { clusterPageMenus = [ { target : { pageId : \"certificates\" }, title : \"Certificates\" , components : { Icon : CertificateIcon , } }, ] } Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates. export default class CrdSampleExtension extends Renderer . LensExtension { ... clusterPages = [{ id : \"certificates\" , components : { Page : () => < CertificatePage extension = { this } /> , MenuIcon : CertificateIcon , } }] } List Certificate Objects on the Cluster Page # 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. Get 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 , CertificatesApi derived 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\" ; const { K8sApi : { KubeObject , KubeObjectStore , KubeApi , apiManager , }, } = Renderer ; export class Certificate extends KubeObject { static kind = \"Certificate\" static namespaced = true static apiBase = \"/apis/cert-manager.io/v1alpha2/certificates\" kind : string apiVersion : string metadata : { name : string ; namespace : string ; selfLink : string ; uid : string ; resourceVersion : string ; creationTimestamp : string ; labels : { [ key : string ] : string ; }; annotations : { [ key : string ] : string ; }; } spec : { dnsNames : string []; issuerRef : { group : string ; kind : string ; name : string ; } secretName : string } status : { conditions : { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type ? : string ; }[]; } } With CertificatesApi class we are able to manage Certificate objects in Kubernetes API: export class CertificatesApi extends KubeApi < Certificate > {} export const certificatesApi = new CertificatesApi ({ objectConstructor : Certificate }); CertificateStore defines storage for Certificate objects export class CertificatesStore extends KubeObjectStore < Certificate > { api = certificatesApi } export const certificatesStore = new CertificatesStore (); And, finally, we register this store to Lens's API manager. apiManager . registerStore ( certificatesStore ); Create CertificatePage component # 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\" ; import React from \"react\" ; import { certificatesStore } from \"../certificate-store\" ; import { Certificate } from \"../certificate\" export class CertificatePage extends React . Component < { extension : Renderer.LensExtension } > { } 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\" ; const { Component : { TabLayout , KubeObjectListLayout , }, } = Renderer ; enum sortBy { name = \"name\" , namespace = \"namespace\" , issuer = \"issuer\" } export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { // ... render () { return ( < TabLayout > < KubeObjectListLayout className = \"Certificates\" store = { certificatesStore } sortingCallbacks = {{ [ sortBy . name ] : ( certificate : Certificate ) => certificate . getName (), [ sortBy . namespace ] : ( certificate : Certificate ) => certificate . metadata . namespace , [ sortBy . issuer ] : ( certificate : Certificate ) => certificate . spec . issuerRef . name }} searchFilters = {[ ( certificate : Certificate ) => certificate . getSearchFields () ]} renderHeaderTitle = \"Certificates\" renderTableHeader = {[ { title : \"Name\" , className : \"name\" , sortBy : sortBy.name }, { title : \"Namespace\" , className : \"namespace\" , sortBy : sortBy.namespace }, { title : \"Issuer\" , className : \"issuer\" , sortBy : sortBy.namespace }, ]} renderTableContents = {( certificate : Certificate ) => [ certificate . getName (), certificate . metadata . namespace , certificate . spec . issuerRef . name ]} /> < /TabLayout> ) } } Customize Details panel # 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 { //... kubeObjectDetailItems = [{ kind : Certificate.kind , apiVersions : [ \"cert-manager.io/v1alpha2\" ], components : { Details : ( props : CertificateDetailsProps ) => < CertificateDetails {... props } /> } }] } 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\" ; import React from \"react\" ; import { Certificate } from \"../certificate\" ; const { Component : { KubeObjectDetailsProps , DrawerItem , Badge , } } = Renderer ; export interface CertificateDetailsProps extends KubeObjectDetailsProps < Certificate > { } export class CertificateDetails extends React . Component < CertificateDetailsProps > { render () { const { object : certificate } = this . props ; if ( ! certificate ) return null ; return ( < div className = \"Certificate\" > < DrawerItem name = \"Created\" > { certificate . getAge ( true , false )} ago ({ certificate . metadata . creationTimestamp }) < /DrawerItem> < DrawerItem name = \"DNS Names\" > { certificate . spec . dnsNames . join ( \",\" )} < /DrawerItem> < DrawerItem name = \"Secret\" > { certificate . spec . secretName } < /DrawerItem> < DrawerItem name = \"Status\" className = \"status\" labelsOnly > { certificate . status . conditions . map (( condition , index ) => { const { type , reason , message , status } = condition ; const kind = type || reason ; if ( ! kind ) return null ; return ( < Badge key = { kind + index } label = { kind } className = { \"success \" + kind . toLowerCase ()} tooltip = { message } /> ); })} < /DrawerItem> < /div> ) } } Summary # 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.","title":"KubeObjectListLayout Sample"},{"location":"extensions/guides/kube-object-list-layout/#kubeobjectlistlayout-sample","text":"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: Register ClusterPage and ClusterPageMenu objects List Certificate Objects on the Cluster Page Customize Details Panel","title":"KubeObjectListLayout Sample"},{"location":"extensions/guides/kube-object-list-layout/#register-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 { } 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\" ; type IconProps = Renderer . Component . IconProps ; const { Component : { Icon , }, } = Renderer ; export function CertificateIcon ( props : IconProps ) { return < Icon {... props } material = \"security\" tooltip = \"Certificates\" /> } export default class CrdSampleExtension extends Renderer . LensExtension { clusterPageMenus = [ { target : { pageId : \"certificates\" }, title : \"Certificates\" , components : { Icon : CertificateIcon , } }, ] } Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates. export default class CrdSampleExtension extends Renderer . LensExtension { ... clusterPages = [{ id : \"certificates\" , components : { Page : () => < CertificatePage extension = { this } /> , MenuIcon : CertificateIcon , } }] }","title":"Register clusterPage and clusterPageMenu Objects"},{"location":"extensions/guides/kube-object-list-layout/#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.","title":"List Certificate Objects on the Cluster Page"},{"location":"extensions/guides/kube-object-list-layout/#get-crd-objects","text":"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 , CertificatesApi derived 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\" ; const { K8sApi : { KubeObject , KubeObjectStore , KubeApi , apiManager , }, } = Renderer ; export class Certificate extends KubeObject { static kind = \"Certificate\" static namespaced = true static apiBase = \"/apis/cert-manager.io/v1alpha2/certificates\" kind : string apiVersion : string metadata : { name : string ; namespace : string ; selfLink : string ; uid : string ; resourceVersion : string ; creationTimestamp : string ; labels : { [ key : string ] : string ; }; annotations : { [ key : string ] : string ; }; } spec : { dnsNames : string []; issuerRef : { group : string ; kind : string ; name : string ; } secretName : string } status : { conditions : { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type ? : string ; }[]; } } With CertificatesApi class we are able to manage Certificate objects in Kubernetes API: export class CertificatesApi extends KubeApi < Certificate > {} export const certificatesApi = new CertificatesApi ({ objectConstructor : Certificate }); CertificateStore defines storage for Certificate objects export class CertificatesStore extends KubeObjectStore < Certificate > { api = certificatesApi } export const certificatesStore = new CertificatesStore (); And, finally, we register this store to Lens's API manager. apiManager . registerStore ( certificatesStore );","title":"Get CRD objects"},{"location":"extensions/guides/kube-object-list-layout/#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\" ; import React from \"react\" ; import { certificatesStore } from \"../certificate-store\" ; import { Certificate } from \"../certificate\" export class CertificatePage extends React . Component < { extension : Renderer.LensExtension } > { } 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\" ; const { Component : { TabLayout , KubeObjectListLayout , }, } = Renderer ; enum sortBy { name = \"name\" , namespace = \"namespace\" , issuer = \"issuer\" } export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { // ... render () { return ( < TabLayout > < KubeObjectListLayout className = \"Certificates\" store = { certificatesStore } sortingCallbacks = {{ [ sortBy . name ] : ( certificate : Certificate ) => certificate . getName (), [ sortBy . namespace ] : ( certificate : Certificate ) => certificate . metadata . namespace , [ sortBy . issuer ] : ( certificate : Certificate ) => certificate . spec . issuerRef . name }} searchFilters = {[ ( certificate : Certificate ) => certificate . getSearchFields () ]} renderHeaderTitle = \"Certificates\" renderTableHeader = {[ { title : \"Name\" , className : \"name\" , sortBy : sortBy.name }, { title : \"Namespace\" , className : \"namespace\" , sortBy : sortBy.namespace }, { title : \"Issuer\" , className : \"issuer\" , sortBy : sortBy.namespace }, ]} renderTableContents = {( certificate : Certificate ) => [ certificate . getName (), certificate . metadata . namespace , certificate . spec . issuerRef . name ]} /> < /TabLayout> ) } }","title":"Create CertificatePage component"},{"location":"extensions/guides/kube-object-list-layout/#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 { //... kubeObjectDetailItems = [{ kind : Certificate.kind , apiVersions : [ \"cert-manager.io/v1alpha2\" ], components : { Details : ( props : CertificateDetailsProps ) => < CertificateDetails {... props } /> } }] } 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\" ; import React from \"react\" ; import { Certificate } from \"../certificate\" ; const { Component : { KubeObjectDetailsProps , DrawerItem , Badge , } } = Renderer ; export interface CertificateDetailsProps extends KubeObjectDetailsProps < Certificate > { } export class CertificateDetails extends React . Component < CertificateDetailsProps > { render () { const { object : certificate } = this . props ; if ( ! certificate ) return null ; return ( < div className = \"Certificate\" > < DrawerItem name = \"Created\" > { certificate . getAge ( true , false )} ago ({ certificate . metadata . creationTimestamp }) < /DrawerItem> < DrawerItem name = \"DNS Names\" > { certificate . spec . dnsNames . join ( \",\" )} < /DrawerItem> < DrawerItem name = \"Secret\" > { certificate . spec . secretName } < /DrawerItem> < DrawerItem name = \"Status\" className = \"status\" labelsOnly > { certificate . status . conditions . map (( condition , index ) => { const { type , reason , message , status } = condition ; const kind = type || reason ; if ( ! kind ) return null ; return ( < Badge key = { kind + index } label = { kind } className = { \"success \" + kind . toLowerCase ()} tooltip = { message } /> ); })} < /DrawerItem> < /div> ) } }","title":"Customize Details panel"},{"location":"extensions/guides/kube-object-list-layout/#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.","title":"Summary"},{"location":"extensions/guides/main-extension/","text":"Main Extension # 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. Main.LensExtension Class # onActivate() and onDeactivate() Methods # To create a main extension simply extend the Main.LensExtension class: import { Main } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends Main . LensExtension { onActivate () { console . log ( \"custom main process extension code started\" ); } onDeactivate () { console . log ( \"custom main process extension de-activated\" ); } } 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: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. 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. appMenus # 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\" ; export default class SamplePageMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click () { console . log ( \"Sample clicked\" ); }, }, ]; } 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\" ; export default class SamplePageMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click : () => this . navigate ( \"myGlobalPage\" ), }, ]; } 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 # 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 { label? : string ; click ?: ( menuItem : TrayMenuRegistration ) => void ; id? : string ; type ?: \"normal\" | \"separator\" | \"submenu\" ; toolTip? : string ; enabled? : boolean ; submenu? : TrayMenuRegistration []; } The following example demonstrates how tray menus can be added from extension: import { Main } from \"@k8slens/extensions\" ; export default class SampleTrayMenuMainExtension extends Main . LensExtension { trayMenus = [ { label : \"menu from the extension\" , click : () => { console . log ( \"tray menu clicked!\" ); }, }, ]; } addCatalogSource() and removeCatalogSource() Methods # 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.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#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.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#mainlensextension-class","text":"","title":"Main.LensExtension Class"},{"location":"extensions/guides/main-extension/#onactivate-and-ondeactivate-methods","text":"To create a main extension simply extend the Main.LensExtension class: import { Main } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends Main . LensExtension { onActivate () { console . log ( \"custom main process extension code started\" ); } onDeactivate () { console . log ( \"custom main process extension de-activated\" ); } } 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: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. 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.","title":"onActivate() and onDeactivate() Methods"},{"location":"extensions/guides/main-extension/#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\" ; export default class SamplePageMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click () { console . log ( \"Sample clicked\" ); }, }, ]; } 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\" ; export default class SamplePageMainExtension extends Main . LensExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click : () => this . navigate ( \"myGlobalPage\" ), }, ]; } 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 ).","title":"appMenus"},{"location":"extensions/guides/main-extension/#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 { label? : string ; click ?: ( menuItem : TrayMenuRegistration ) => void ; id? : string ; type ?: \"normal\" | \"separator\" | \"submenu\" ; toolTip? : string ; enabled? : boolean ; submenu? : TrayMenuRegistration []; } The following example demonstrates how tray menus can be added from extension: import { Main } from \"@k8slens/extensions\" ; export default class SampleTrayMenuMainExtension extends Main . LensExtension { trayMenus = [ { label : \"menu from the extension\" , click : () => { console . log ( \"tray menu clicked!\" ); }, }, ]; }","title":"trayMenus"},{"location":"extensions/guides/main-extension/#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.","title":"addCatalogSource() and removeCatalogSource() Methods"},{"location":"extensions/guides/protocol-handlers/","text":"Lens Protocol Handlers # 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. Registering A Protocol Handler # 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\" ; function rootHandler ( params : Common.Types.ProtocolRouteParams ) { console . log ( \"routed to ExampleExtension\" , params ); } export default class ExampleExtensionMain extends Main . LensExtension { protocolHandlers = [ pathSchema : \"/\" , handler : rootHandler , ] } 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/ Deregistering A Protocol Handler # All that is needed to deregister a handler is to remove it from the array of handlers. Routing Algorithm # 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): { \"search\" : { \"text\" : \"Hello\" }, \"pathname\" : { \"type\" : \"notification\" } } 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.","title":"Protocol Handlers"},{"location":"extensions/guides/protocol-handlers/#lens-protocol-handlers","text":"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.","title":"Lens Protocol Handlers"},{"location":"extensions/guides/protocol-handlers/#registering-a-protocol-handler","text":"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\" ; function rootHandler ( params : Common.Types.ProtocolRouteParams ) { console . log ( \"routed to ExampleExtension\" , params ); } export default class ExampleExtensionMain extends Main . LensExtension { protocolHandlers = [ pathSchema : \"/\" , handler : rootHandler , ] } 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/","title":"Registering A Protocol Handler"},{"location":"extensions/guides/protocol-handlers/#deregistering-a-protocol-handler","text":"All that is needed to deregister a handler is to remove it from the array of handlers.","title":"Deregistering A Protocol Handler"},{"location":"extensions/guides/protocol-handlers/#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): { \"search\" : { \"text\" : \"Hello\" }, \"pathname\" : { \"type\" : \"notification\" } } 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.","title":"Routing Algorithm"},{"location":"extensions/guides/renderer-extension/","text":"Renderer Extension (WIP) # 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: Cluster pages Cluster page menus Global pages Welcome menus App preferences Top bar items Status bar items KubeObject menu items KubeObject detail items KubeObject status texts Kube workloads overview items as well as catalog-related UI elements: Entity settings Catalog entity detail items All UI elements are based on React components. Finally, you can also add commands and protocol handlers: Command palette commands protocol handlers Renderer.LensExtension Class # onActivate() and onDeactivate() Methods # To create a renderer extension, extend the Renderer.LensExtension class: import { Renderer } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends Renderer . LensExtension { onActivate () { console . log ( \"custom renderer process extension code started\" ); } onDeactivate () { console . log ( \"custom renderer process extension de-activated\" ); } } 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. (On Mac, it is **Lens** > **Extensions**.) 2. For the extension you want to disable, open the context menu (click on the three vertical dots) and choose **Disable**. The example above logs messages when the extension is enabled and disabled. clusterPages # 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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; } 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 . 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\" ; import React from \"react\" ; export class ExamplePage extends React . Component < { extension : LensRendererExtension ; } > { render () { return ( < div > < p > Hello world !< /p> < /div> ); } } 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 # 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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , }, }, ]; } 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\" ; import React from \"react\" ; type IconProps = Renderer . Component . IconProps ; const { Component : { Icon }, } = Renderer ; export function ExampleIcon ( props : IconProps ) { return < Icon {... props } material = \"pages\" tooltip = { \"Hi!\" } /> ; } export class ExamplePage extends React . Component < { extension : Renderer.LensExtension ; } > { render () { return ( < div > < p > Hello world !< /p> < /div> ); } } 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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, { id : \"bonjour\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; clusterPageMenus = [ { id : \"example\" , title : \"Greetings\" , components : { Icon : ExampleIcon , }, }, { parentId : \"example\" , target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , }, }, { parentId : \"example\" , target : { pageId : \"bonjour\" }, title : \"Bonjour le monde\" , components : { Icon : ExampleIcon , }, }, ]; } 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: globalPages # 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\" ; import { HelpPage } from \"./page\" ; import React from \"react\" ; export default class HelpExtension extends Renderer . LensExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , }, }, ]; } 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 . 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\" ; import React from \"react\" ; export class HelpPage extends React . Component < { extension : LensRendererExtension ; } > { render () { return ( < div > < p > Help yourself < /p> < /div> ); } } 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: To add global pages to the top menu bar, see appMenus in the Main Extension guide. To add global pages as an interactive element in the blue status bar along the bottom of the Lens UI, see statusBarItems . To add global pages to the Welcome Page, see welcomeMenus . welcomeMenus # appPreferences # 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\" ; import { ExamplePreferenceHint , ExamplePreferenceInput , } from \"./src/example-preference\" ; import { observable } from \"mobx\" ; import React from \"react\" ; export default class ExampleRendererExtension extends Renderer . LensExtension { @observable preference = { enabled : false }; appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { this . preference } /> , Hint : () => < ExamplePreferenceHint /> , }, }, ]; } 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\" ; import { makeObservable } from \"mobx\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; const { Component : { Checkbox }, } = Renderer ; export class ExamplePreferenceProps { preference : { enabled : boolean ; }; } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { public constructor () { super ({ preference : { enabled : false } }); makeObservable ( this ); } render () { const { preference } = this . props ; return ( < Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = {( v ) => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render () { return < span > This is an example of an appPreference for extensions . < /span>; } } 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 # statusBarItems # 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\" ; import { HelpIcon , HelpPage } from \"./page\" ; import React from \"react\" ; export default class HelpExtension extends Renderer . LensExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , }, }, ]; statusBarItems = [ { components : { Item : () => ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ), }, }, ]; } 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 # 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\" ; import { Renderer } from \"@k8slens/extensions\" ; import { NamespaceMenuItem } from \"./src/namespace-menu-item\" ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; export default class ExampleExtension extends Renderer . LensExtension { kubeObjectMenuItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : KubeObjectMenuProps < Namespace > ) => ( < NamespaceMenuItem {... props } /> ), }, }, ]; } 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\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { terminalStore , MenuItem , Icon }, Navigation , } = Renderer ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; export function NamespaceMenuItem ( props : KubeObjectMenuProps < Namespace > ) { const { object : namespace , toolbar } = props ; if ( ! namespace ) return null ; const namespaceName = namespace . getName (); const sendToTerminal = ( command : string ) => { terminalStore . sendCommand ( command , { enter : true , newTab : true , }); Navigation . hideDetails (); }; const getPods = () => { sendToTerminal ( `kubectl get pods -n ${ namespaceName } ` ); }; return ( < MenuItem onClick = { getPods } > < Icon material = \"speaker_group\" interactive = { toolbar } title = \"Get pods in terminal\" /> < span className = \"title\" > Get Pods < /span> < /MenuItem> ); } 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 # 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\" ; import { Renderer } from \"@k8slens/extensions\" ; import { NamespaceDetailsItem } from \"./src/namespace-details-item\" ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type KubeObjectDetailsProps = Renderer . Component . KubeObjectDetailsProps ; type Namespace = Renderer . K8sApi . Namespace ; export default class ExampleExtension extends Renderer . LensExtension { kubeObjectDetailItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], priority : 10 , components : { Details : ( props : KubeObjectDetailsProps < Namespace > ) => ( < NamespaceDetailsItem {... props } /> ), }, }, ]; } 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\" ; import { PodsDetailsList } from \"./pods-details-list\" ; import React from \"react\" ; import { observable } from \"mobx\" ; import { observer } from \"mobx-react\" ; const { K8sApi : { podsApi }, Component : { DrawerTitle }, } = Renderer ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; type Pod = Renderer . K8sApi . Pod ; @observer export class NamespaceDetailsItem extends React . Component < KubeObjectDetailsProps < Namespace > > { @observable private pods : Pod []; async componentDidMount () { const namespace = this . props . object . getName (); this . pods = await podsApi . list ({ namespace }); } render () { return ( < div > < DrawerTitle > Pods < /DrawerTitle> < PodsDetailsList pods = { this . pods } /> < /div> ); } } Since NamespaceDetailsItem extends React.Component> , 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 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\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { TableHead , TableRow , TableCell , Table }, } = Renderer ; type Pod = Renderer . K8sApi . Pod ; interface PodsDetailsListProps { pods? : Pod []; } export class PodsDetailsList extends React . Component < PodsDetailsListProps > { getTableRow = ( pod : Pod ) => { return ( < TableRow key = { index } nowrap > < TableCell className = \"podName\" > { pods [ index ]. getName ()} < /TableCell> < TableCell className = \"podAge\" > { pods [ index ]. getAge ()} < /TableCell> < TableCell className = \"podStatus\" > { pods [ index ]. getStatus ()} < /TableCell> < /TableRow> ); }; render () { const { pods } = this . props ; if ( ! pods ? . length ) { return null ; } return ( < div > < Table > < TableHead > < TableCell className = \"podName\" > Name < /TableCell> < TableCell className = \"podAge\" > Age < /TableCell> < TableCell className = \"podStatus\" > Status < /TableCell> < /TableHead> { pods . map ( this . getTableRow )} < /Table> < /div> ); } } 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 # kubeWorkloadsOverviewItems # entitySettings # catalogEntityDetailItems # commandPaletteCommands # protocolHandlers # See the Protocol Handlers Guide","title":"Renderer Extension"},{"location":"extensions/guides/renderer-extension/#renderer-extension-wip","text":"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: Cluster pages Cluster page menus Global pages Welcome menus App preferences Top bar items Status bar items KubeObject menu items KubeObject detail items KubeObject status texts Kube workloads overview items as well as catalog-related UI elements: Entity settings Catalog entity detail items All UI elements are based on React components. Finally, you can also add commands and protocol handlers: Command palette commands protocol handlers","title":"Renderer Extension (WIP)"},{"location":"extensions/guides/renderer-extension/#rendererlensextension-class","text":"","title":"Renderer.LensExtension Class"},{"location":"extensions/guides/renderer-extension/#onactivate-and-ondeactivate-methods","text":"To create a renderer extension, extend the Renderer.LensExtension class: import { Renderer } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends Renderer . LensExtension { onActivate () { console . log ( \"custom renderer process extension code started\" ); } onDeactivate () { console . log ( \"custom renderer process extension de-activated\" ); } } 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. (On Mac, it is **Lens** > **Extensions**.) 2. For the extension you want to disable, open the context menu (click on the three vertical dots) and choose **Disable**. The example above logs messages when the extension is enabled and disabled.","title":"onActivate() and onDeactivate() Methods"},{"location":"extensions/guides/renderer-extension/#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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; } 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 . 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\" ; import React from \"react\" ; export class ExamplePage extends React . Component < { extension : LensRendererExtension ; } > { render () { return ( < div > < p > Hello world !< /p> < /div> ); } } 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.","title":"clusterPages"},{"location":"extensions/guides/renderer-extension/#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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , }, }, ]; } 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\" ; import React from \"react\" ; type IconProps = Renderer . Component . IconProps ; const { Component : { Icon }, } = Renderer ; export function ExampleIcon ( props : IconProps ) { return < Icon {... props } material = \"pages\" tooltip = { \"Hi!\" } /> ; } export class ExamplePage extends React . Component < { extension : Renderer.LensExtension ; } > { render () { return ( < div > < p > Hello world !< /p> < /div> ); } } 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\" ; import { ExampleIcon , ExamplePage } from \"./page\" ; import React from \"react\" ; export default class ExampleExtension extends Renderer . LensExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, { id : \"bonjour\" , components : { Page : () => < ExamplePage extension = { this } /> , }, }, ]; clusterPageMenus = [ { id : \"example\" , title : \"Greetings\" , components : { Icon : ExampleIcon , }, }, { parentId : \"example\" , target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , }, }, { parentId : \"example\" , target : { pageId : \"bonjour\" }, title : \"Bonjour le monde\" , components : { Icon : ExampleIcon , }, }, ]; } 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:","title":"clusterPageMenus"},{"location":"extensions/guides/renderer-extension/#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\" ; import { HelpPage } from \"./page\" ; import React from \"react\" ; export default class HelpExtension extends Renderer . LensExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , }, }, ]; } 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 . 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\" ; import React from \"react\" ; export class HelpPage extends React . Component < { extension : LensRendererExtension ; } > { render () { return ( < div > < p > Help yourself < /p> < /div> ); } } 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: To add global pages to the top menu bar, see appMenus in the Main Extension guide. To add global pages as an interactive element in the blue status bar along the bottom of the Lens UI, see statusBarItems . To add global pages to the Welcome Page, see welcomeMenus .","title":"globalPages"},{"location":"extensions/guides/renderer-extension/#welcomemenus","text":"","title":"welcomeMenus"},{"location":"extensions/guides/renderer-extension/#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\" ; import { ExamplePreferenceHint , ExamplePreferenceInput , } from \"./src/example-preference\" ; import { observable } from \"mobx\" ; import React from \"react\" ; export default class ExampleRendererExtension extends Renderer . LensExtension { @observable preference = { enabled : false }; appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { this . preference } /> , Hint : () => < ExamplePreferenceHint /> , }, }, ]; } 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\" ; import { makeObservable } from \"mobx\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; const { Component : { Checkbox }, } = Renderer ; export class ExamplePreferenceProps { preference : { enabled : boolean ; }; } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { public constructor () { super ({ preference : { enabled : false } }); makeObservable ( this ); } render () { const { preference } = this . props ; return ( < Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = {( v ) => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render () { return < span > This is an example of an appPreference for extensions . < /span>; } } 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 .","title":"appPreferences"},{"location":"extensions/guides/renderer-extension/#topbaritems","text":"","title":"topBarItems"},{"location":"extensions/guides/renderer-extension/#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\" ; import { HelpIcon , HelpPage } from \"./page\" ; import React from \"react\" ; export default class HelpExtension extends Renderer . LensExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , }, }, ]; statusBarItems = [ { components : { Item : () => ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ), }, }, ]; } 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.","title":"statusBarItems"},{"location":"extensions/guides/renderer-extension/#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\" ; import { Renderer } from \"@k8slens/extensions\" ; import { NamespaceMenuItem } from \"./src/namespace-menu-item\" ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; export default class ExampleExtension extends Renderer . LensExtension { kubeObjectMenuItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : KubeObjectMenuProps < Namespace > ) => ( < NamespaceMenuItem {... props } /> ), }, }, ]; } 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\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { terminalStore , MenuItem , Icon }, Navigation , } = Renderer ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; export function NamespaceMenuItem ( props : KubeObjectMenuProps < Namespace > ) { const { object : namespace , toolbar } = props ; if ( ! namespace ) return null ; const namespaceName = namespace . getName (); const sendToTerminal = ( command : string ) => { terminalStore . sendCommand ( command , { enter : true , newTab : true , }); Navigation . hideDetails (); }; const getPods = () => { sendToTerminal ( `kubectl get pods -n ${ namespaceName } ` ); }; return ( < MenuItem onClick = { getPods } > < Icon material = \"speaker_group\" interactive = { toolbar } title = \"Get pods in terminal\" /> < span className = \"title\" > Get Pods < /span> < /MenuItem> ); } 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.","title":"kubeObjectMenuItems"},{"location":"extensions/guides/renderer-extension/#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\" ; import { Renderer } from \"@k8slens/extensions\" ; import { NamespaceDetailsItem } from \"./src/namespace-details-item\" ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type KubeObjectDetailsProps = Renderer . Component . KubeObjectDetailsProps ; type Namespace = Renderer . K8sApi . Namespace ; export default class ExampleExtension extends Renderer . LensExtension { kubeObjectDetailItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], priority : 10 , components : { Details : ( props : KubeObjectDetailsProps < Namespace > ) => ( < NamespaceDetailsItem {... props } /> ), }, }, ]; } 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\" ; import { PodsDetailsList } from \"./pods-details-list\" ; import React from \"react\" ; import { observable } from \"mobx\" ; import { observer } from \"mobx-react\" ; const { K8sApi : { podsApi }, Component : { DrawerTitle }, } = Renderer ; type KubeObjectMenuProps = Renderer . Component . KubeObjectMenuProps ; type Namespace = Renderer . K8sApi . Namespace ; type Pod = Renderer . K8sApi . Pod ; @observer export class NamespaceDetailsItem extends React . Component < KubeObjectDetailsProps < Namespace > > { @observable private pods : Pod []; async componentDidMount () { const namespace = this . props . object . getName (); this . pods = await podsApi . list ({ namespace }); } render () { return ( < div > < DrawerTitle > Pods < /DrawerTitle> < PodsDetailsList pods = { this . pods } /> < /div> ); } } Since NamespaceDetailsItem extends React.Component> , 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 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\" ; import { Renderer } from \"@k8slens/extensions\" ; const { Component : { TableHead , TableRow , TableCell , Table }, } = Renderer ; type Pod = Renderer . K8sApi . Pod ; interface PodsDetailsListProps { pods? : Pod []; } export class PodsDetailsList extends React . Component < PodsDetailsListProps > { getTableRow = ( pod : Pod ) => { return ( < TableRow key = { index } nowrap > < TableCell className = \"podName\" > { pods [ index ]. getName ()} < /TableCell> < TableCell className = \"podAge\" > { pods [ index ]. getAge ()} < /TableCell> < TableCell className = \"podStatus\" > { pods [ index ]. getStatus ()} < /TableCell> < /TableRow> ); }; render () { const { pods } = this . props ; if ( ! pods ? . length ) { return null ; } return ( < div > < Table > < TableHead > < TableCell className = \"podName\" > Name < /TableCell> < TableCell className = \"podAge\" > Age < /TableCell> < TableCell className = \"podStatus\" > Status < /TableCell> < /TableHead> { pods . map ( this . getTableRow )} < /Table> < /div> ); } } 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.","title":"kubeObjectDetailItems"},{"location":"extensions/guides/renderer-extension/#kubeobjectstatustexts","text":"","title":"kubeObjectStatusTexts"},{"location":"extensions/guides/renderer-extension/#kubeworkloadsoverviewitems","text":"","title":"kubeWorkloadsOverviewItems"},{"location":"extensions/guides/renderer-extension/#entitysettings","text":"","title":"entitySettings"},{"location":"extensions/guides/renderer-extension/#catalogentitydetailitems","text":"","title":"catalogEntityDetailItems"},{"location":"extensions/guides/renderer-extension/#commandpalettecommands","text":"","title":"commandPaletteCommands"},{"location":"extensions/guides/renderer-extension/#protocolhandlers","text":"See the Protocol Handlers Guide","title":"protocolHandlers"},{"location":"extensions/guides/resource-stack/","text":"Resource Stack (Cluster Feature) # 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 kind : Pod metadata : name : example-pod spec : containers : - name : example-pod image : nginx 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\" ; import * as path from \"path\" ; const { K8sApi : { ResourceStack , forCluster , Pod , } } = Renderer ; type ResourceStack = Renderer . K8sApi . ResourceStack ; type Pod = Renderer . K8sApi . Pod ; type KubernetesCluster = Common . Catalog . KubernetesCluster ; export class ExampleClusterFeature { protected stack : ResourceStack ; constructor ( protected cluster : KubernetesCluster ) { this . stack = new ResourceStack ( cluster , \"example-resource-stack\" ); } get resourceFolder () { return path . join ( __dirname , \"../resources/\" ); } install () : Promise < string > { console . log ( \"installing example-pod\" ); return this . stack . kubectlApplyFolder ( this . resourceFolder ); } async isInstalled () : Promise < boolean > { try { const podApi = forCluster ( this . cluster , Pod ); const examplePod = await podApi . get ({ name : \"example-pod\" , namespace : \"default\" }); if ( examplePod ? . kind ) { console . log ( \"found example-pod\" ); return true ; } } catch ( e ) { console . log ( \"Error getting example-pod:\" , e ); } console . log ( \"didn't find example-pod\" ); return false ; } async uninstall () : Promise < string > { console . log ( \"uninstalling example-pod\" ); return this . stack . kubectlDeleteFolder ( this . resourceFolder ); } } 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\" ; import { Common , Renderer } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import { computed , observable , makeObservable } from \"mobx\" ; import { ExampleClusterFeature } from \"./example-cluster-feature\" ; const { Component : { SubTitle , Button , } } = Renderer ; interface ExampleClusterFeatureSettingsProps { cluster : Common.Catalog.KubernetesCluster ; } @observer export class ExampleClusterFeatureSettings extends React . Component < ExampleClusterFeatureSettingsProps > { constructor ( props : ExampleClusterFeatureSettingsProps ) { super ( props ); makeObservable ( this ); } @observable installed = false ; @observable inProgress = false ; feature : ExampleClusterFeature ; async componentDidMount () { this . feature = new ExampleClusterFeature ( this . props . cluster ); await this . updateFeatureState (); } async updateFeatureState () { this . installed = await this . feature . isInstalled (); } async save () { this . inProgress = true ; try { if ( this . installed ) { await this . feature . uninstall (); } else { await this . feature . install (); } } finally { this . inProgress = false ; await this . updateFeatureState (); } } @computed get buttonLabel () { if ( this . inProgress && this . installed ) return \"Uninstalling ...\" ; if ( this . inProgress ) return \"Applying ...\" ; if ( this . installed ) { return \"Uninstall\" ; } return \"Apply\" ; } render () { return ( <> < section > < SubTitle title = \"Example Cluster Feature using a Resource Stack\" /> < Button label = { this . buttonLabel } waiting = { this . inProgress } onClick = {() => this . save ()} primary /> < /section> < /> ); } } 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\" ; import { ExampleClusterFeatureSettings } from \"./src/example-cluster-feature-settings\" import React from \"react\" export default class ExampleExtension extends Renderer . LensExtension { entitySettings = [ { apiVersions : [ \"entity.k8slens.dev/v1alpha1\" ], kind : \"KubernetesCluster\" , title : \"Example Cluster Feature\" , priority : 5 , components : { View : ({ entity = null } : { entity : Common.Catalog.KubernetesCluster }) => ( < ExampleClusterFeatureSettings cluster = { entity } /> ) } } ]; } 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.","title":"Resource Stack"},{"location":"extensions/guides/resource-stack/#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 kind : Pod metadata : name : example-pod spec : containers : - name : example-pod image : nginx 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\" ; import * as path from \"path\" ; const { K8sApi : { ResourceStack , forCluster , Pod , } } = Renderer ; type ResourceStack = Renderer . K8sApi . ResourceStack ; type Pod = Renderer . K8sApi . Pod ; type KubernetesCluster = Common . Catalog . KubernetesCluster ; export class ExampleClusterFeature { protected stack : ResourceStack ; constructor ( protected cluster : KubernetesCluster ) { this . stack = new ResourceStack ( cluster , \"example-resource-stack\" ); } get resourceFolder () { return path . join ( __dirname , \"../resources/\" ); } install () : Promise < string > { console . log ( \"installing example-pod\" ); return this . stack . kubectlApplyFolder ( this . resourceFolder ); } async isInstalled () : Promise < boolean > { try { const podApi = forCluster ( this . cluster , Pod ); const examplePod = await podApi . get ({ name : \"example-pod\" , namespace : \"default\" }); if ( examplePod ? . kind ) { console . log ( \"found example-pod\" ); return true ; } } catch ( e ) { console . log ( \"Error getting example-pod:\" , e ); } console . log ( \"didn't find example-pod\" ); return false ; } async uninstall () : Promise < string > { console . log ( \"uninstalling example-pod\" ); return this . stack . kubectlDeleteFolder ( this . resourceFolder ); } } 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\" ; import { Common , Renderer } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import { computed , observable , makeObservable } from \"mobx\" ; import { ExampleClusterFeature } from \"./example-cluster-feature\" ; const { Component : { SubTitle , Button , } } = Renderer ; interface ExampleClusterFeatureSettingsProps { cluster : Common.Catalog.KubernetesCluster ; } @observer export class ExampleClusterFeatureSettings extends React . Component < ExampleClusterFeatureSettingsProps > { constructor ( props : ExampleClusterFeatureSettingsProps ) { super ( props ); makeObservable ( this ); } @observable installed = false ; @observable inProgress = false ; feature : ExampleClusterFeature ; async componentDidMount () { this . feature = new ExampleClusterFeature ( this . props . cluster ); await this . updateFeatureState (); } async updateFeatureState () { this . installed = await this . feature . isInstalled (); } async save () { this . inProgress = true ; try { if ( this . installed ) { await this . feature . uninstall (); } else { await this . feature . install (); } } finally { this . inProgress = false ; await this . updateFeatureState (); } } @computed get buttonLabel () { if ( this . inProgress && this . installed ) return \"Uninstalling ...\" ; if ( this . inProgress ) return \"Applying ...\" ; if ( this . installed ) { return \"Uninstall\" ; } return \"Apply\" ; } render () { return ( <> < section > < SubTitle title = \"Example Cluster Feature using a Resource Stack\" /> < Button label = { this . buttonLabel } waiting = { this . inProgress } onClick = {() => this . save ()} primary /> < /section> < /> ); } } 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\" ; import { ExampleClusterFeatureSettings } from \"./src/example-cluster-feature-settings\" import React from \"react\" export default class ExampleExtension extends Renderer . LensExtension { entitySettings = [ { apiVersions : [ \"entity.k8slens.dev/v1alpha1\" ], kind : \"KubernetesCluster\" , title : \"Example Cluster Feature\" , priority : 5 , components : { View : ({ entity = null } : { entity : Common.Catalog.KubernetesCluster }) => ( < ExampleClusterFeatureSettings cluster = { entity } /> ) } } ]; } 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.","title":"Resource Stack (Cluster Feature)"},{"location":"extensions/guides/stores/","text":"Stores # Stores are components that persist and synchronize state data. Lens uses a number of stores to maintain various kinds of state information, including: The ClusterStore manages cluster state data (such as cluster details), and it tracks which cluster is active. The WorkspaceStore manages workspace state data (such as the workspace name), and and it tracks which clusters belong to a given workspace. The ExtensionStore manages custom extension state data. This guide focuses on the ExtensionStore . 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\" ; import { observable , makeObservable } from \"mobx\" ; export type ExamplePreferencesModel = { enabled : boolean ; }; export class ExamplePreferencesStore extends Common . Store . ExtensionStore < ExamplePreferencesModel > { @observable enabled = false ; private constructor () { super ({ configName : \"example-preferences-store\" , defaults : { enabled : false } }); makeObservable ( this ); } protected fromStore ({ enabled } : ExamplePreferencesModel ) : void { this . enabled = enabled ; } toJSON () : ExamplePreferencesModel { return { enabled : this.enabled }; } } 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\" ; import { ExamplePreferencesStore } from \"./src/example-preference-store\" ; export default class ExampleMainExtension extends Main . LensExtension { async onActivate () { await ExamplePreferencesStore . getInstanceOrCreate (). loadExtension ( this ); } } 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\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { ExamplePreferencesStore } from \"./src/example-preference-store\" ; import React from \"react\" ; export default class ExampleRendererExtension extends Renderer . LensExtension { async onActivate () { await ExamplePreferencesStore . getInstanceOrCreate (). loadExtension ( this ); } appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput /> , Hint : () => < ExamplePreferenceHint /> } } ]; } 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\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; import { ExamplePreferencesStore } from \"./example-preference-store\" ; const { Component : { Checkbox , }, } = Renderer ; @observer export class ExamplePreferenceInput extends React . Component { render () { return ( < Checkbox label = \"I understand appPreferences\" value = { ExamplePreferencesStore . getInstance (). enabled } onChange = { v => { ExamplePreferencesStore . getInstance (). enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render () { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } 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 .","title":"Stores"},{"location":"extensions/guides/stores/#stores","text":"Stores are components that persist and synchronize state data. Lens uses a number of stores to maintain various kinds of state information, including: The ClusterStore manages cluster state data (such as cluster details), and it tracks which cluster is active. The WorkspaceStore manages workspace state data (such as the workspace name), and and it tracks which clusters belong to a given workspace. The ExtensionStore manages custom extension state data. This guide focuses on the ExtensionStore .","title":"Stores"},{"location":"extensions/guides/stores/#extensionstore","text":"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\" ; import { observable , makeObservable } from \"mobx\" ; export type ExamplePreferencesModel = { enabled : boolean ; }; export class ExamplePreferencesStore extends Common . Store . ExtensionStore < ExamplePreferencesModel > { @observable enabled = false ; private constructor () { super ({ configName : \"example-preferences-store\" , defaults : { enabled : false } }); makeObservable ( this ); } protected fromStore ({ enabled } : ExamplePreferencesModel ) : void { this . enabled = enabled ; } toJSON () : ExamplePreferencesModel { return { enabled : this.enabled }; } } 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\" ; import { ExamplePreferencesStore } from \"./src/example-preference-store\" ; export default class ExampleMainExtension extends Main . LensExtension { async onActivate () { await ExamplePreferencesStore . getInstanceOrCreate (). loadExtension ( this ); } } 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\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { ExamplePreferencesStore } from \"./src/example-preference-store\" ; import React from \"react\" ; export default class ExampleRendererExtension extends Renderer . LensExtension { async onActivate () { await ExamplePreferencesStore . getInstanceOrCreate (). loadExtension ( this ); } appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput /> , Hint : () => < ExamplePreferenceHint /> } } ]; } 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\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; import { ExamplePreferencesStore } from \"./example-preference-store\" ; const { Component : { Checkbox , }, } = Renderer ; @observer export class ExamplePreferenceInput extends React . Component { render () { return ( < Checkbox label = \"I understand appPreferences\" value = { ExamplePreferencesStore . getInstance (). enabled } onChange = { v => { ExamplePreferencesStore . getInstance (). enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render () { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } 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 .","title":"ExtensionStore"},{"location":"extensions/guides/working-with-mobx/","text":"Working with MobX # Introduction # 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. React does some optimizations around re-rendering components after quick successions of setState calls. How MobX Works: # 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 .","title":"Working with MobX"},{"location":"extensions/guides/working-with-mobx/#working-with-mobx","text":"","title":"Working with MobX"},{"location":"extensions/guides/working-with-mobx/#introduction","text":"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. React does some optimizations around re-rendering components after quick successions of setState calls.","title":"Introduction"},{"location":"extensions/guides/working-with-mobx/#how-mobx-works","text":"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 .","title":"How MobX Works:"},{"location":"extensions/testing-and-publishing/bundling/","text":"","title":"Bundling"},{"location":"extensions/testing-and-publishing/publishing/","text":"Publishing Extensions # 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. Places To Host Your Extension # 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. Publishing via NPM # 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. Run npm version to bump the version of your extension by the appropriate amount. Run npm publish to publish your extension to NPM Run git 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 dist.tarball This will output the link that they will need to give to Lens to install your extension. Publish via GitHub Releases # 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. Making a NPM Tarball of Your Extension # 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 This will create a NPM tarball that can be hosted on GitHub Releases or any other publicly available file hosting service.","title":"Publishing Extensions"},{"location":"extensions/testing-and-publishing/publishing/#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.","title":"Publishing Extensions"},{"location":"extensions/testing-and-publishing/publishing/#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.","title":"Places To Host Your Extension"},{"location":"extensions/testing-and-publishing/publishing/#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. Run npm version to bump the version of your extension by the appropriate amount. Run npm publish to publish your extension to NPM Run git 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 dist.tarball This will output the link that they will need to give to Lens to install your extension.","title":"Publishing via NPM"},{"location":"extensions/testing-and-publishing/publishing/#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.","title":"Publish via GitHub Releases"},{"location":"extensions/testing-and-publishing/publishing/#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 This will create a NPM tarball that can be hosted on GitHub Releases or any other publicly available file hosting service.","title":"Making a NPM Tarball of Your Extension"},{"location":"extensions/testing-and-publishing/testing/","text":"Testing Extensions # Renderer Process Unit Testing # 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\" import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , }, } = Renderer ; const GlobalPageMenuIcon = ({ navigate } : { navigate ?: () => void }) : JSX . Element => ( < Icon material = \"trip_origin\" onClick = {() => navigate ()} data - testid = \"global-page-menu-icon\" /> ) The test import React from \"react\" import { render , screen , fireEvent } from \"@testing-library/react\" ; import GlobalPageMenuIcon from \"./GlobalPageMenuIcon\" ; test ( \"click called navigate()\" , () => { const navigate = jest . fn (); render ( < GlobalPageMenuIcon navigate = { navigate } /> ); fireEvent . click ( screen . getByTestId ( \"global-page-menu-icon\" )); expect ( navigate ). toHaveBeenCalled (); }); 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. Main Process Unit Testing # 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. Tips # Console.log # 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 . Renderer Process Logs # In the Renderer process, console.log() is printed in the Console in Developer Tools ( View > Toggle Developer Tools ). Main Process Logs # Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools. macOS # On macOS, view the Main process logs by running Lens from the terminal: /Applications/Lens.app/Contents/MacOS/Lens You can also use Console.app to view the Main process logs. Linux # On Linux, you can access the Main process logs using the Lens PID. First get the PID: ps aux | grep Lens | grep -v grep Then get the Main process logs using the PID: tail -f /proc/ [ pid ] /fd/1 # stdout (console.log) tail -f /proc/ [ pid ] /fd/2 # stdout (console.error)","title":"Testing Extensions"},{"location":"extensions/testing-and-publishing/testing/#testing-extensions","text":"","title":"Testing Extensions"},{"location":"extensions/testing-and-publishing/testing/#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\" import { Renderer } from \"@k8slens/extensions\" ; const { Component : { Icon , }, } = Renderer ; const GlobalPageMenuIcon = ({ navigate } : { navigate ?: () => void }) : JSX . Element => ( < Icon material = \"trip_origin\" onClick = {() => navigate ()} data - testid = \"global-page-menu-icon\" /> ) The test import React from \"react\" import { render , screen , fireEvent } from \"@testing-library/react\" ; import GlobalPageMenuIcon from \"./GlobalPageMenuIcon\" ; test ( \"click called navigate()\" , () => { const navigate = jest . fn (); render ( < GlobalPageMenuIcon navigate = { navigate } /> ); fireEvent . click ( screen . getByTestId ( \"global-page-menu-icon\" )); expect ( navigate ). toHaveBeenCalled (); }); 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.","title":"Renderer Process Unit Testing"},{"location":"extensions/testing-and-publishing/testing/#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.","title":"Main Process Unit Testing"},{"location":"extensions/testing-and-publishing/testing/#tips","text":"","title":"Tips"},{"location":"extensions/testing-and-publishing/testing/#consolelog","text":"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 .","title":"Console.log"},{"location":"extensions/testing-and-publishing/testing/#renderer-process-logs","text":"In the Renderer process, console.log() is printed in the Console in Developer Tools ( View > Toggle Developer Tools ).","title":"Renderer Process Logs"},{"location":"extensions/testing-and-publishing/testing/#main-process-logs","text":"Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools.","title":"Main Process Logs"},{"location":"extensions/usage/","text":"Using Extensions # 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. Installing an Extension # 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\\\\.k8slens\\extensions ) folder and Lens will automatically detect it and install the extension. Enabling or Disabling an 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. Uninstalling an Extension # 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.","title":"Using Extensions"},{"location":"extensions/usage/#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.","title":"Using Extensions"},{"location":"extensions/usage/#installing-an-extension","text":"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\\\\.k8slens\\extensions ) folder and Lens will automatically detect it and install the extension.","title":"Installing an Extension"},{"location":"extensions/usage/#enabling-or-disabling-an-extension","text":"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.","title":"Enabling or Disabling an Extension"},{"location":"extensions/usage/#uninstalling-an-extension","text":"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.","title":"Uninstalling an Extension"}]} \ No newline at end of file diff --git a/master/sitemap.xml b/master/sitemap.xml index d4337b8881..881ecd5f74 100644 --- a/master/sitemap.xml +++ b/master/sitemap.xml @@ -1285,6 +1285,21 @@ 2023-02-17 daily + + https://api-docs.k8slens.dev/master/extensions/api/interfaces/Renderer.K8sApi.MetricData/ + 2023-02-17 + daily + + + https://api-docs.k8slens.dev/master/extensions/api/interfaces/Renderer.K8sApi.MetricResult/ + 2023-02-17 + daily + + + https://api-docs.k8slens.dev/master/extensions/api/interfaces/Renderer.K8sApi.RequestMetricsParams/ + 2023-02-17 + daily + https://api-docs.k8slens.dev/master/extensions/api/interfaces/Renderer.Navigation.PageParamInit/ 2023-02-17 diff --git a/master/sitemap.xml.gz b/master/sitemap.xml.gz index 64e01a4198..fd46d94059 100644 Binary files a/master/sitemap.xml.gz and b/master/sitemap.xml.gz differ