- -
-
- displayName
-
-
-
-
-
extension
@@ -802,8 +788,15 @@
-
-
- params
+
+ persistentStorage
+
+
+
+
+ -
+
+ rawParams
@@ -913,11 +906,6 @@
-Hierarchy
-
-↳ ExtensionStore
Table of contents
Constructors
Properties
Methods
Constructors
constructor
-• new ExtensionStore<T>(«destructured»)
+• new ExtensionStore<T>(rawParams)
Type parameters
-Overrides
-BaseStore<T\>.constructor
Properties
-displayName
-• Readonly displayName: string
-Inherited from
-BaseStore.displayName
-
extension
• Protected Optional extension: LensExtension<LensExtensionDependencies>
-params
-• Protected Readonly params: BaseStoreParams<T>
-Inherited from
-BaseStore.params
+persistentStorage
+• Protected Optional persistentStorage: PersistentStorage
+
+rawParams
+• Protected Readonly rawParams: ExtensionStoreParams<T>
Methods
cwd
▸ Protected cwd(): string
Returns
string
-Overrides
-BaseStore.cwd
fromStore
-▸ Protected Abstract fromStore(data): void
-fromStore is called internally when a child class syncs with the file
-system.
-Note: This function must be synchronous.
+▸ Abstract fromStore(data): void
Parameters
| Name |
Type |
-Description |
data |
-T |
-the parsed information read from the stored JSON file |
+Partial<T> |
Returns
void
-Inherited from
-BaseStore.fromStore
load
▸ load(): void
+Deprecated
+Never use this method. Instead call BaseExtensionStore.loadExtension
Returns
void
-Overrides
-BaseStore.load
loadExtension
▸ loadExtension(extension): void
@@ -1052,14 +1025,8 @@ system.
toJSON
▸ 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
▸ Static createInstance<T, R>(this, ...args): T
diff --git a/master/extensions/api/classes/Main.Ipc/index.html b/master/extensions/api/classes/Main.Ipc/index.html
index 6042fe5223..848e328be0 100644
--- a/master/extensions/api/classes/Main.Ipc/index.html
+++ b/master/extensions/api/classes/Main.Ipc/index.html
@@ -918,7 +918,7 @@
[IpcPrefix]
• Readonly [IpcPrefix]: string
Inherited from
-IpcRegistrar.__@IpcPrefix@1590
+IpcRegistrar.__@IpcPrefix@5715
extension
• Protected Readonly extension: LensExtension<LensExtensionDependencies>
diff --git a/master/extensions/api/classes/Main.K8sApi.KubeObjectStore/index.html b/master/extensions/api/classes/Main.K8sApi.KubeObjectStore/index.html
index 426b10cb34..551d4d7b07 100644
--- a/master/extensions/api/classes/Main.K8sApi.KubeObjectStore/index.html
+++ b/master/extensions/api/classes/Main.K8sApi.KubeObjectStore/index.html
@@ -1536,7 +1536,7 @@
Returns
Generator<K, void, undefined>
Inherited from
-InternalKubeObjectStore.__@iterator@187
+InternalKubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.Ipc/index.html b/master/extensions/api/classes/Renderer.Ipc/index.html
index a2066e7d03..a568c7e33d 100644
--- a/master/extensions/api/classes/Renderer.Ipc/index.html
+++ b/master/extensions/api/classes/Renderer.Ipc/index.html
@@ -918,7 +918,7 @@
[IpcPrefix]
• Readonly [IpcPrefix]: string
Inherited from
-IpcRegistrar.__@IpcPrefix@1590
+IpcRegistrar.__@IpcPrefix@5715
extension
• Protected Readonly extension: LensExtension<LensExtensionDependencies>
diff --git a/master/extensions/api/classes/Renderer.K8sApi.CRDResourceStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.CRDResourceStore/index.html
index d0f05f288d..25ddd54c67 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.CRDResourceStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.CRDResourceStore/index.html
@@ -1447,7 +1447,7 @@
Returns
Generator<K, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.CRDStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.CRDStore/index.html
index 25d4c33a08..ce17636404 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.CRDStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.CRDStore/index.html
@@ -1443,7 +1443,7 @@
Returns
Generator<CustomResourceDefinition, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/index.html
index 76d190d881..a15aff93d2 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<ConfigMap, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.CronJobStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.CronJobStore/index.html
index f03abc3163..5b419144b8 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.CronJobStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.CronJobStore/index.html
@@ -1430,7 +1430,7 @@
Returns
Generator<CronJob, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.DaemonSetStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.DaemonSetStore/index.html
index 43a2b4d941..267685a77d 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.DaemonSetStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.DaemonSetStore/index.html
@@ -1430,7 +1430,7 @@
Returns
Generator<DaemonSet, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.DeploymentStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.DeploymentStore/index.html
index 1898c6d129..01d7cbb4cc 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.DeploymentStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.DeploymentStore/index.html
@@ -1430,7 +1430,7 @@
Returns
Generator<Deployment, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.EndpointStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.EndpointStore/index.html
index 53e7737d42..0102e5928d 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.EndpointStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.EndpointStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<Endpoint, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.EventStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.EventStore/index.html
index 346d464992..576da2ec9b 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.EventStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.EventStore/index.html
@@ -1438,7 +1438,7 @@
Returns
Generator<KubeEvent, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.HPAStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.HPAStore/index.html
index ec6011ad37..2d82de9528 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.HPAStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.HPAStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<HorizontalPodAutoscaler, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.IngressClassStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.IngressClassStore/index.html
index b4b954134c..ef592bbf63 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.IngressClassStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.IngressClassStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<IngressClass, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.IngressStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.IngressStore/index.html
index ea75684b75..a078f74e68 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.IngressStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.IngressStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<Ingress, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.JobStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.JobStore/index.html
index 89e1ee91c9..29a6dad6a8 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.JobStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.JobStore/index.html
@@ -1438,7 +1438,7 @@
Returns
Generator<Job, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.KubeObjectStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.KubeObjectStore/index.html
index b362bcafc8..f3900257c5 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.KubeObjectStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.KubeObjectStore/index.html
@@ -1536,7 +1536,7 @@
Returns
Generator<K, void, undefined>
Inherited from
-InternalKubeObjectStore.__@iterator@187
+InternalKubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.LimitRangesStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.LimitRangesStore/index.html
index 6d7435b8dc..b544885a08 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.LimitRangesStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.LimitRangesStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<LimitRange, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.NamespaceStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.NamespaceStore/index.html
index c34269863f..a1c71f2f58 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.NamespaceStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.NamespaceStore/index.html
@@ -1589,7 +1589,7 @@ the filter or if the user has clicked the "All Namespaces" option
Returns
Generator<Namespace, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/index.html
index 443a8ce8e4..ee7f833427 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.NetworkPolicyStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<NetworkPolicy, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.NodesStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.NodesStore/index.html
index fb3495e173..2879f33b60 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.NodesStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.NodesStore/index.html
@@ -1448,7 +1448,7 @@
Returns
Generator<Node, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/index.html
index 4ee2c050f3..e7f1a46b42 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.PersistentVolumesStore/index.html
@@ -1422,7 +1422,7 @@
Returns
Generator<PersistentVolume, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/index.html
index 41e11eb84d..cd55cccf62 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.PodDisruptionBudgetsStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<PodDisruptionBudget, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.PodsStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.PodsStore/index.html
index b24fb57e16..0a54895afa 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.PodsStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.PodsStore/index.html
@@ -1473,7 +1473,7 @@
Returns
Generator<Pod, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/index.html
index 62f0ce6111..898299abce 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.PriorityClassStoreStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<PriorityClass, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/index.html
index 749abaf0de..7dd557e849 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.ReplicaSetStore/index.html
@@ -1438,7 +1438,7 @@
Returns
Generator<ReplicaSet, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/index.html
index 87d1247c63..6b1f75a188 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.ResourceQuotasStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<ResourceQuota, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/index.html
index a3f8ba9f27..5d910c2560 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.RoleBindingsStore/index.html
@@ -1430,7 +1430,7 @@
Returns
Generator<RoleBinding, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.RolesStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.RolesStore/index.html
index 4a817886d1..69f79c16d3 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.RolesStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.RolesStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<Role, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.SecretsStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.SecretsStore/index.html
index 0ac4376eae..fcc504284d 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.SecretsStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.SecretsStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<Secret, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/index.html
index 388ce628e0..e1fe42862d 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.ServiceAccountsStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<ServiceAccount, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.ServiceStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.ServiceStore/index.html
index 2d3174f503..e21d483124 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.ServiceStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.ServiceStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<Service, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.StatefulSetStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.StatefulSetStore/index.html
index b50dc9ee90..e5946c92ef 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.StatefulSetStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.StatefulSetStore/index.html
@@ -1430,7 +1430,7 @@
Returns
Generator<StatefulSet, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.StorageClassStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.StorageClassStore/index.html
index 3636433ebe..cbfde2e9ab 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.StorageClassStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.StorageClassStore/index.html
@@ -1422,7 +1422,7 @@
Returns
Generator<StorageClass, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/index.html
index 95f93f0155..f20ffdc783 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.VerticalPodAutoscalerStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<VerticalPodAutoscaler, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/index.html
index dce677367f..92d6481dc8 100644
--- a/master/extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/index.html
+++ b/master/extensions/api/classes/Renderer.K8sApi.VolumeClaimStore/index.html
@@ -1414,7 +1414,7 @@
Returns
Generator<PersistentVolumeClaim, void, undefined>
Inherited from
-KubeObjectStore.__@iterator@187
+KubeObjectStore.__@iterator@50
bindWatchEventsUpdater
▸ Protected bindWatchEventsUpdater(delay?): void
diff --git a/master/extensions/api/interfaces/Common.Store.BaseStoreParams/index.html b/master/extensions/api/interfaces/Common.Store.ExtensionStoreParams/index.html
similarity index 93%
rename from master/extensions/api/interfaces/Common.Store.BaseStoreParams/index.html
rename to master/extensions/api/interfaces/Common.Store.ExtensionStoreParams/index.html
index b502466bde..96ce5aa897 100644
--- a/master/extensions/api/interfaces/Common.Store.BaseStoreParams/index.html
+++ b/master/extensions/api/interfaces/Common.Store.ExtensionStoreParams/index.html
@@ -13,7 +13,7 @@
-
+
@@ -23,7 +23,7 @@
- Interface: BaseStoreParams - Lens Extension Development
+ Interface: ExtensionStoreParams - Lens Extension Development
@@ -88,7 +88,7 @@
-
+
Skip to content
@@ -126,7 +126,7 @@
@@ -758,6 +758,20 @@
configName
+
+
+
-
+
+ cwd
+
+
+
+
+
-
+
+ migrations
+
+
-
@@ -786,40 +800,50 @@
-
Interface: BaseStoreParams<T>
-Common.Store.BaseStoreParams
+ Interface: ExtensionStoreParams<T>
+Common.Store.ExtensionStoreParams
Type parameters
| Name |
+Type |
T |
+extends object |
Hierarchy
-Omit<ConfOptions<T>, "migrations">Omit<PersistentStorageParams<T>, "migrations" | "cwd" | "fromStore" | "toJSON">
-↳ BaseStoreParams
+↳ ExtensionStoreParams
Table of contents
Properties
Properties
configName
-• configName: string
-Overrides
+• Readonly configName: string
+Inherited from
Omit.configName
+cwd
+• Optional cwd: string
+
+migrations
+• Optional migrations: Migrations<T>
+
syncOptions
-• Optional syncOptions: Object
+• Optional Readonly syncOptions: Object
Type declaration
+Inherited from
+Omit.syncOptions
diff --git a/master/extensions/api/interfaces/Common.Store.PersistentStorageParams/index.html b/master/extensions/api/interfaces/Common.Store.PersistentStorageParams/index.html
new file mode 100644
index 0000000000..e1bda1cd36
--- /dev/null
+++ b/master/extensions/api/interfaces/Common.Store.PersistentStorageParams/index.html
@@ -0,0 +1,1000 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Interface: PersistentStorageParams - Lens Extension Development
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Interface: PersistentStorageParams<T>
+Common.Store.PersistentStorageParams
+Type parameters
+
+
+
+| Name |
+Type |
+
+
+
+
+T |
+extends object |
+
+
+
+Hierarchy
+
+Omit<Options<T>, "migrations">
+↳ PersistentStorageParams
+Table of contents
+Properties
+
+Methods
+
+Properties
+configName
+• Readonly configName: string
+Overrides
+Omit.configName
+
+migrations
+• Optional Readonly migrations: Partial<Record<string, (store: MigrationStore) => void>>
+
+syncOptions
+• Optional Readonly syncOptions: Object
+Type declaration
+
+
+
+| Name |
+Type |
+
+
+
+
+equals? |
+IEqualsComparer<T> |
+
+
+fireImmediately? |
+boolean |
+
+
+
+Methods
+fromStore
+▸ 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 |
+Partial<T> |
+the parsed information read from the stored JSON file |
+
+
+
+Returns
+void
+
+toJSON
+▸ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Interfaces
diff --git a/master/extensions/api/modules/Common/index.html b/master/extensions/api/modules/Common/index.html
index 9dacf268e1..a5b9a2591e 100644
--- a/master/extensions/api/modules/Common/index.html
+++ b/master/extensions/api/modules/Common/index.html
@@ -884,7 +884,7 @@ Licensed under MIT License. See LICENSE in root directory for more information.<
slackUrl |
"" |
-Deprecated This value is now "" and is left here for backwards compatability. |
+Deprecated This value is now "" and is left here for backwards compatibility. |
version |
diff --git a/master/extensions/api/modules/Renderer.Navigation/index.html b/master/extensions/api/modules/Renderer.Navigation/index.html
index 3a9cd3a5f0..6d825d5894 100644
--- a/master/extensions/api/modules/Renderer.Navigation/index.html
+++ b/master/extensions/api/modules/Renderer.Navigation/index.html
@@ -938,7 +938,7 @@
route |
-string | string[] | RouteProps<string, {}> |
+string | RouteProps<string, {}> | string[] |
diff --git a/master/search/search_index.json b/master/search/search_index.json
index e4b43b560b..88cef88694 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 Forums . It's a public chatroom for Lens developers, where Lens team members chime in from time to time. To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens . Please use the labels area/documentation and/or area/extension . 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 Forums . It's a public chatroom for Lens developers, where Lens team members chime in from time to time. To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens . Please use the labels area/documentation and/or area/extension .","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 Implements # LegacyLensExtension 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 Implementation of # LegacyLensExtension.id isBundled # \u2022 Readonly isBundled : boolean Implementation of # LegacyLensExtension.isBundled manifest # \u2022 Readonly manifest : LensExtensionManifest Implementation of # LegacyLensExtension.manifest manifestPath # \u2022 Readonly manifestPath : string Implementation of # LegacyLensExtension.manifestPath protocolHandlers # \u2022 protocolHandlers : ProtocolHandlerRegistration [] Accessors # description # \u2022 get description (): undefined | string Returns # undefined | string Implementation of # LegacyLensExtension.description isEnabled # \u2022 get isEnabled (): boolean Returns # boolean name # \u2022 get name (): string Returns # string Implementation of # LegacyLensExtension.name sanitizedExtensionId # \u2022 get sanitizedExtensionId (): string Returns # string Implementation of # LegacyLensExtension.sanitizedExtensionId storeName # \u2022 get storeName (): string Returns # string Implementation of # LegacyLensExtension.storeName version # \u2022 get version (): string Returns # string Implementation of # LegacyLensExtension.version Methods # activate # \u25b8 activate (): Promise < void > Returns # Promise < void > Implementation of # LegacyLensExtension.activate disable # \u25b8 disable (): Promise < void > Returns # Promise < void > Implementation of # LegacyLensExtension.disable enable # \u25b8 enable (): Promise < void > Returns # Promise < void > Implementation of # LegacyLensExtension.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 > Implementation of # LegacyLensExtension.getExtensionFileFolder 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/#implements","text":"LegacyLensExtension","title":"Implements"},{"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@1590 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@187 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 status Methods # getExplanation 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 Optional Readonly message : string reason # \u2022 Optional Readonly reason : string status # \u2022 Optional Readonly status : string Methods # getExplanation # \u25b8 getExplanation (): string Returns # 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 status","title":"Properties"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#methods","text":"getExplanation","title":"Methods"},{"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 Optional Readonly message : string","title":"message"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#reason","text":"\u2022 Optional Readonly reason : string","title":"reason"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#status","text":"\u2022 Optional Readonly status : string","title":"status"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.K8sApi.KubeStatus/#getexplanation","text":"\u25b8 getExplanation (): string","title":"getExplanation"},{"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