@k8slens/extensions / Exports / Main / K8sApi
Namespace: K8sApi#
Main.K8sApi
Table of contents#
References#
- createKubeObject
- isJsonApiData
- isJsonApiDataList
- isKubeJsonApiListMetadata
- isKubeJsonApiMetadata
- isKubeObjectNonSystem
- isPartialJsonApiData
- isPartialJsonApiMetadata
- stringifyLabels
Classes#
- ClusterRole
- ClusterRoleBinding
- ConfigMap
- CronJob
- CustomResourceDefinition
- DaemonSet
- Deployment
- Endpoint
- HorizontalPodAutoscaler
- Ingress
- Job
- KubeEvent
- KubeObject
- KubeObjectStore
- KubeStatus
- LimitRange
- Namespace
- NetworkPolicy
- Node
- PersistentVolume
- PersistentVolumeClaim
- Pod
- PodDisruptionBudget
- PriorityClass
- ReplicaSet
- ResourceQuota
- ResourceStack
- Role
- RoleBinding
- Secret
- Service
- ServiceAccount
- StatefulSet
- StorageClass
Interfaces#
- BaseKubeJsonApiObjectMetadata
- ExternalKubeApiOptions
- IKubeApiCluster
- ILocalKubeApiConfig
- IPodContainer
- IPodContainerStatus
- IRemoteKubeApiConfig
- ISecretRef
- IgnoredKubeApiOptions
- KubeJsonApiData
- KubeObjectStoreLoadAllParams
- KubeObjectStoreLoadingParams
- KubeObjectStoreSubscribeParams
- KubeStatusData
- OwnerReference
Type Aliases#
- ClusterScopedMetadata
- DeploymentApi
- IngressApi
- JsonPatch
- KubeApi
- KubeJsonApi
- KubeJsonApiDataFor
- KubeJsonApiObjectMetadata
- KubeObjectMetadata
- NamespaceScopedMetadata
- NodesApi
- PersistentVolumeClaimsApi
- PodsApi
Variables#
Functions#
References#
createKubeObject#
Renames and re-exports __type
isJsonApiData#
Renames and re-exports __type
isJsonApiDataList#
Renames and re-exports __type
isKubeJsonApiListMetadata#
Renames and re-exports __type
isKubeJsonApiMetadata#
Renames and re-exports __type
isKubeObjectNonSystem#
Renames and re-exports __type
isPartialJsonApiData#
Renames and re-exports __type
isPartialJsonApiMetadata#
Renames and re-exports __type
stringifyLabels#
Renames and re-exports __type
Type Aliases#
ClusterScopedMetadata#
Ƭ ClusterScopedMetadata: KubeObjectMetadata<KubeObjectScope.Cluster>
DeploymentApi#
Ƭ DeploymentApi: InternalDeploymentApi
IngressApi#
Ƭ IngressApi: InternalIngressApi
JsonPatch#
Ƭ JsonPatch: Patch
KubeApi#
Ƭ KubeApi<Object, Data>: InternalKubeApi<Object, Data>
Type parameters#
| Name | Type |
|---|---|
Object |
extends KubeObject = KubeObject |
Data |
extends KubeJsonApiDataFor<Object> = KubeJsonApiDataFor<Object> |
KubeJsonApi#
Ƭ KubeJsonApi: InternalKubeJsonApi
KubeJsonApiDataFor#
Ƭ KubeJsonApiDataFor<K>: K extends KubeObject<infer Metadata, infer Status, infer Spec> ? KubeJsonApiData<Metadata, Status, Spec> : never
Type parameters#
| Name |
|---|
K |
KubeJsonApiObjectMetadata#
Ƭ KubeJsonApiObjectMetadata<Namespaced>: BaseKubeJsonApiObjectMetadata<Namespaced> & Namespaced extends KubeObjectScope.Namespace ? { namespace: string } : {}
Type parameters#
| Name | Type |
|---|---|
Namespaced |
extends KubeObjectScope = KubeObjectScope |
KubeObjectMetadata#
Ƭ KubeObjectMetadata<Namespaced>: KubeJsonApiObjectMetadata<Namespaced> & { selfLink: string }
Type parameters#
| Name | Type |
|---|---|
Namespaced |
extends KubeObjectScope = KubeObjectScope |
NamespaceScopedMetadata#
Ƭ NamespaceScopedMetadata: KubeObjectMetadata<KubeObjectScope.Namespace>
NodesApi#
Ƭ NodesApi: NodeApi
PersistentVolumeClaimsApi#
Ƭ PersistentVolumeClaimsApi: PersistentVolumeClaimApi
PodsApi#
Ƭ PodsApi: PodApi
Variables#
DeploymentApi#
• DeploymentApi: (opts?: DerivedKubeApiOptions) => DeploymentApi
Type declaration#
• new DeploymentApi(opts?)
Parameters#
| Name | Type |
|---|---|
opts? |
DerivedKubeApiOptions |
IngressApi#
• IngressApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => IngressApi
Type declaration#
• new IngressApi(opts?)
Parameters#
| Name | Type |
|---|---|
opts? |
DerivedKubeApiOptions & IgnoredKubeApiOptions |
KubeApi#
• KubeApi: <Object_1, Data>(opts: KubeApiOptions<Object_1, Data> & ExternalKubeApiOptions) => KubeApi<Object_1, Data>
Type declaration#
• new KubeApi<Object_1, Data>(opts)
Type parameters#
| Name | Type |
|---|---|
Object_1 |
extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object_1> = KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> |
Data |
extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data> = KubeJsonApiDataFor<Object_1> |
Parameters#
| Name | Type |
|---|---|
opts |
KubeApiOptions<Object_1, Data> & ExternalKubeApiOptions |
KubeJsonApi#
• KubeJsonApi: (config: JsonApiConfig, reqInit?: RequestInit) => KubeJsonApi & { forCluster: CreateKubeJsonApiForCluster }
NodesApi#
• NodesApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => NodeApi
Type declaration#
• new NodesApi(opts?)
Parameters#
| Name | Type |
|---|---|
opts? |
DerivedKubeApiOptions & IgnoredKubeApiOptions |
PersistentVolumeClaimsApi#
• PersistentVolumeClaimsApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => PersistentVolumeClaimApi
Type declaration#
• new PersistentVolumeClaimsApi(opts?)
Parameters#
| Name | Type |
|---|---|
opts? |
DerivedKubeApiOptions & IgnoredKubeApiOptions |
PodsApi#
• PodsApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => PodApi
Type declaration#
• new PodsApi(opts?)
Parameters#
| Name | Type |
|---|---|
opts? |
DerivedKubeApiOptions & IgnoredKubeApiOptions |
apiManager#
• Const apiManager: ApiManager
Functions#
createResourceStack#
▸ createResourceStack(cluster, name): ResourceApplyingStack
Parameters#
| Name | Type |
|---|---|
cluster |
KubernetesCluster<KubernetesClusterMetadata, KubernetesClusterStatus, KubernetesClusterSpec> |
name |
string |
Returns#
ResourceApplyingStack
forCluster#
▸ forCluster<Object, Api, Data>(cluster, kubeClass, apiClass): Api
Type parameters#
| Name | Type |
|---|---|
Object |
extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> |
Api |
extends KubeApi<Object, KubeJsonApiDataFor<Object>, Api> |
Data |
extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data> |
Parameters#
| Name | Type |
|---|---|
cluster |
ILocalKubeApiConfig |
kubeClass |
KubeObjectConstructor<Object, Data> |
apiClass |
KubeApiConstructor<Object, Api> |
Returns#
Api
▸ forCluster<Object, Data>(cluster, kubeClass, apiClass?): KubeApi<Object, KubeJsonApiDataFor<Object>>
Type parameters#
| Name | Type |
|---|---|
Object |
extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> |
Data |
extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data> |
Parameters#
| Name | Type |
|---|---|
cluster |
ILocalKubeApiConfig |
kubeClass |
KubeObjectConstructor<Object, Data> |
apiClass? |
KubeApiConstructor<Object, KubeApi<Object, KubeJsonApiDataFor<Object>>> |
Returns#
KubeApi<Object, KubeJsonApiDataFor<Object>>
forRemoteCluster#
▸ forRemoteCluster<Object, Api, Data>(config, kubeClass, apiClass): Api
Type parameters#
| Name | Type |
|---|---|
Object |
extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> |
Api |
extends KubeApi<Object, KubeJsonApiDataFor<Object>, Api> |
Data |
extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data> |
Parameters#
| Name | Type |
|---|---|
config |
IRemoteKubeApiConfig |
kubeClass |
KubeObjectConstructor<Object, Data> |
apiClass |
KubeApiConstructor<Object, Api> |
Returns#
Api
▸ forRemoteCluster<Object, Data>(config, kubeClass, apiClass?): KubeApi<Object, KubeJsonApiDataFor<Object>>
Type parameters#
| Name | Type |
|---|---|
Object |
extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> |
Data |
extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data> |
Parameters#
| Name | Type |
|---|---|
config |
IRemoteKubeApiConfig |
kubeClass |
KubeObjectConstructor<Object, Data> |
apiClass? |
KubeApiConstructor<Object, KubeApi<Object, KubeJsonApiDataFor<Object>>> |
Returns#
KubeApi<Object, KubeJsonApiDataFor<Object>>
getPodsByOwnerId#
▸ getPodsByOwnerId(ownerId): Pod[]
Parameters#
| Name | Type |
|---|---|
ownerId |
string |
Returns#
Pod[]
isAllowedResource#
▸ isAllowedResource(...args): boolean
Deprecated
This function never works
Parameters#
| Name | Type |
|---|---|
...args |
any[] |
Returns#
boolean
false
isKubeStatusData#
▸ isKubeStatusData(object): object is KubeStatusData
Is the shape of object correct for KubeStatusData
Parameters#
| Name | Type | Description |
|---|---|---|
object |
unknown |
Some object |
Returns#
object is KubeStatusData