Class: Pod

Extends

KubeObject<KubePod>

Constructors

Constructor

new Pod(jsonData: KubePod, cluster?: string): Pod;

Defined in: lib/k8s/pod.ts:126

Parameters

Parameter	Type
`jsonData`	`KubePod`
`cluster?`	`string`

Returns

Pod

Overrides

KubeObject.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
`_clusterName`	`public`	`string`	`undefined`	-	-	`KubeObject`.`_clusterName`	lib/k8s/KubeObject.ts:51
`jsonData`	`public`	`KubePod`	`undefined`	-	-	`KubeObject`.`jsonData`	lib/k8s/KubeObject.ts:48
`_internalApiEndpoint?`	`static`	\| `ApiClient`<`KubeObjectInterface`> \| `ApiWithNamespaceClient`<`KubeObjectInterface`>	`undefined`	-	-	`KubeObject`.`_internalApiEndpoint`	lib/k8s/KubeObject.ts:68
`apiName`	`static`	`string`	`'pods'`	Name of the resource, plural, used in API	`KubeObject`.`apiName`	-	lib/k8s/pod.ts:120
`apiVersion`	`static`	`string`	`'v1'`	Group and version of the resource formatted as "GROUP/VERSION", e.g. "policy.k8s.io/v1".	`KubeObject`.`apiVersion`	-	lib/k8s/pod.ts:121
`isNamespaced`	`static`	`boolean`	`true`	Whether the object is namespaced.	`KubeObject`.`isNamespaced`	-	lib/k8s/pod.ts:122
`isScalable`	`readonly`	`boolean`	`undefined`	Whether the object is scalable, and should have a ScaleButton	-	`KubeObject`.`isScalable`	lib/k8s/KubeObject.ts:66
`kind`	`static`	`string`	`'Pod'`	The kind of the object. Corresponding to the resource kind in Kubernetes.	`KubeObject`.`kind`	-	lib/k8s/pod.ts:119
`readOnlyFields`	`static`	`string`[]	`[]`	Readonly field defined as JSONPath paths	-	`KubeObject`.`readOnlyFields`	lib/k8s/KubeObject.ts:50

Accessors

cluster

Get Signature

get cluster(): string;

Defined in: lib/k8s/KubeObject.ts:106

Returns

string

Set Signature

set cluster(cluster: string): void;

Defined in: lib/k8s/KubeObject.ts:110

Parameters

Parameter	Type
`cluster`	`string`

Returns

void

Inherited from

KubeObject.cluster

detailsRoute

Get Signature

get detailsRoute(): string;

Defined in: lib/k8s/KubeObject.ts:118

Returns

string

Inherited from

KubeObject.detailsRoute

isNamespaced

Get Signature

get isNamespaced(): boolean;

Defined in: lib/k8s/KubeObject.ts:226

Returns

boolean

Inherited from

KubeObject.isNamespaced

isScalable

Get Signature

get isScalable(): boolean;

Defined in: lib/k8s/KubeObject.ts:230

Returns

boolean

Inherited from

KubeObject.isScalable

kind

Get Signature

get kind(): any;

Defined in: lib/k8s/KubeObject.ts:180

Returns

any

Inherited from

KubeObject.kind

listRoute

Get Signature

get listRoute(): string;

Defined in: lib/k8s/KubeObject.ts:172

Returns

string

Inherited from

KubeObject.listRoute

metadata

Get Signature

get metadata(): KubeMetadata;

Defined in: lib/k8s/KubeObject.ts:222

Returns

KubeMetadata

Inherited from

KubeObject.metadata

pluralName

Get Signature

get pluralName(): string;

Defined in: lib/k8s/KubeObject.ts:167

Returns

string

Inherited from

KubeObject.pluralName

spec

Get Signature

get spec(): KubePodSpec;

Defined in: lib/k8s/pod.ts:131

Returns

KubePodSpec

status

Get Signature

get status(): object;

Defined in: lib/k8s/pod.ts:135

Returns

object

conditions

conditions: KubeCondition[];

containerStatuses

containerStatuses: KubeContainerStatus[];

ephemeralContainerStatuses?

optional ephemeralContainerStatuses?: KubeContainerStatus[];

hostIP?

optional hostIP?: string;

hostIPs?

optional hostIPs?: object[];

initContainerStatuses?

optional initContainerStatuses?: KubeContainerStatus[];

message?

optional message?: string;

nominatedNodeName?

optional nominatedNodeName?: string;

phase

phase: string;

podIPs?

optional podIPs?: object[];

qosClass?

optional qosClass?: string;

reason?

optional reason?: string;

startTime

startTime: Time;

apiEndpoint

Get Signature

get static apiEndpoint(): 
  | ApiClient<KubeObjectInterface>
| ApiWithNamespaceClient<KubeObjectInterface>;

Defined in: lib/k8s/KubeObject.ts:70

Returns

| ApiClient<KubeObjectInterface> | ApiWithNamespaceClient<KubeObjectInterface>

Set Signature

set static apiEndpoint(endpoint: 
  | ApiClient<KubeObjectInterface>
  | ApiWithNamespaceClient<KubeObjectInterface>): void;

Defined in: lib/k8s/KubeObject.ts:97

Parameters

Parameter	Type
`endpoint`	\| `ApiClient`<`KubeObjectInterface`> \| `ApiWithNamespaceClient`<`KubeObjectInterface`>

Returns

void

Inherited from

KubeObject.apiEndpoint

apiGroupName

Get Signature

get static apiGroupName(): string | undefined;

Defined in: lib/k8s/KubeObject.ts:134

Get name of the API group of this resource for example will return batch for CronJob

For core group, like Pods, it will return undefined

API group reference https://kubernetes.io/docs/reference/using-api/#api-groups

Returns

string | undefined

Inherited from

KubeObject.apiGroupName

className

Get Signature

get static className(): string;

Defined in: lib/k8s/KubeObject.ts:114

Returns

string

Inherited from

KubeObject.className

detailsRoute

Get Signature

get static detailsRoute(): string;

Defined in: lib/k8s/KubeObject.ts:122

Returns

string

Inherited from

KubeObject.detailsRoute

listRoute

Get Signature

get static listRoute(): string;

Defined in: lib/k8s/KubeObject.ts:176

Returns

string

Inherited from

KubeObject.listRoute

pluralName

Get Signature

get static pluralName(): string;

Defined in: lib/k8s/KubeObject.ts:161

Returns

string

Inherited from

KubeObject.pluralName

Methods

_class()

_class(): typeof KubeObject;

Defined in: lib/k8s/KubeObject.ts:490

Returns

typeof KubeObject

Inherited from

KubeObject._class

addEphemeralContainer()

addEphemeralContainer(
   containerName: string, 
   image: string, 
command?: string[]): Promise<void>;

Defined in: lib/k8s/pod.ts:309

Add an ephemeral container to the pod.

Parameters

Parameter	Type	Description
`containerName`	`string`	The name of the ephemeral container to add
`image`	`string`	The container image to use
`command`	`string`[]	Optional command to run in the container (defaults to ['sh'])

Returns

Promise<void>

Promise that resolves when the ephemeral container is added

attach()

attach(
   container: string, 
   onAttach: StreamResultsCb, 
   options?: StreamArgs): object;

Defined in: lib/k8s/pod.ts:263

Parameters

Parameter	Type
`container`	`string`
`onAttach`	`StreamResultsCb`
`options`	`StreamArgs`

Returns

object

cancel

cancel: () => void;

Returns

void

getSocket

getSocket: () => WebSocket | null;

Returns

WebSocket | null

delete()

delete(force?: boolean): Promise<any>;

Defined in: lib/k8s/KubeObject.ts:494

Parameters

Parameter	Type
`force?`	`boolean`

Returns

Promise<any>

Inherited from

KubeObject.delete

evict()

evict(): Promise<any>;

Defined in: lib/k8s/pod.ts:139

Returns

Promise<any>

exec()

exec(
   container: string, 
   onExec: StreamResultsCb, 
   options?: ExecOptions): object;

Defined in: lib/k8s/pod.ts:280

Parameters

Parameter	Type
`container`	`string`
`onExec`	`StreamResultsCb`
`options`	`ExecOptions`

Returns

object

cancel

cancel: () => void;

Returns

void

getSocket

getSocket: () => WebSocket | null;

Returns

WebSocket | null

getAge()

getAge(): string;

Defined in: lib/k8s/KubeObject.ts:214

Returns

string

Inherited from

KubeObject.getAge

getAuthorization()

getAuthorization(verb: string, reqResourseAttrs?: AuthRequestResourceAttrs): Promise<any>;

Defined in: lib/k8s/KubeObject.ts:690

Parameters

Parameter	Type
`verb`	`string`
`reqResourseAttrs?`	`AuthRequestResourceAttrs`

Returns

Promise<any>

Inherited from

KubeObject.getAuthorization

getCreationTs()

getCreationTs(): string;

Defined in: lib/k8s/KubeObject.ts:210

Returns

string

Inherited from

KubeObject.getCreationTs

getDetailedStatus()

getDetailedStatus(): PodDetailedStatus;

Defined in: lib/k8s/pod.ts:373

Returns

PodDetailedStatus

getDetailsLink()

getDetailsLink(): string;

Defined in: lib/k8s/KubeObject.ts:184

Returns

string

Inherited from

KubeObject.getDetailsLink

getEditableObject()

getEditableObject(): object;

Defined in: lib/k8s/KubeObject.ts:234

Returns

object

Inherited from

KubeObject.getEditableObject

getListLink()

getListLink(): string;

Defined in: lib/k8s/KubeObject.ts:198

Returns

string

Inherited from

KubeObject.getListLink

getLogs()

getLogs(...args: 
  | [string, number, boolean, StreamResultsCb]
  | [string, LogStreamResultsCb, LogOptions]): () => void;

Defined in: lib/k8s/pod.ts:149

Parameters

Parameter	Type
...`args`	\| [`string`, `number`, `boolean`, `StreamResultsCb`] \| [`string`, `LogStreamResultsCb`, `LogOptions`]

Returns

() => void

getName()

getName(): string;

Defined in: lib/k8s/KubeObject.ts:202

Returns

string

Inherited from

KubeObject.getName

getNamespace()

getNamespace(): string | undefined;

Defined in: lib/k8s/KubeObject.ts:206

Returns

string | undefined

Inherited from

KubeObject.getNamespace

getValue()

getValue(prop: string): any;

Defined in: lib/k8s/KubeObject.ts:218

Parameters

Parameter	Type
`prop`	`string`

Returns

any

Inherited from

KubeObject.getValue

patch()

patch(body: RecursivePartial<T>): Promise<any>;

Defined in: lib/k8s/KubeObject.ts:598

Parameters

Parameter	Type
`body`	`RecursivePartial`<`T`>

Returns

Promise<any>

Inherited from

KubeObject.patch

patchUpdate()

patchUpdate(original: KubeObjectInterface, modified: KubeObjectInterface): Promise<KubeObjectInterface>;

Defined in: lib/k8s/KubeObject.ts:522

Updates a resource using JSON Patch (RFC 6902), sending only the diff between the original and modified objects. This avoids 409 Conflict errors on resources that are frequently updated by controllers (e.g. HPA).

Parameters

Parameter	Type
`original`	`KubeObjectInterface`
`modified`	`KubeObjectInterface`

Returns

Promise<KubeObjectInterface>

Inherited from

KubeObject.patchUpdate

scale()

scale(numReplicas: number): Promise<any>;

Defined in: lib/k8s/KubeObject.ts:569

Parameters

Parameter	Type
`numReplicas`	`number`

Returns

Promise<any>

Inherited from

KubeObject.scale

update()

update(data: KubeObjectInterface): Promise<KubeObjectInterface>;

Defined in: lib/k8s/KubeObject.ts:513

Parameters

Parameter	Type
`data`	`KubeObjectInterface`

Returns

Promise<KubeObjectInterface>

Inherited from

KubeObject.update

apiGet()

static apiGet<K>(
   this: (...args: any) => K & typeof KubeObject, 
   onGet: (...args: any) => void, 
   name: string, 
   namespace?: string, 
   onError?: (err: ApiError | null, cluster?: string) => void, 
   opts?: object): (...args: any[]) => Promise;

Defined in: lib/k8s/KubeObject.ts:447

Type Parameters

Type Parameter
`K` extends `KubeObject`<`any`>

Parameters

Parameter	Type
`this`	(...`args`: `any`) => `K` & typeof `KubeObject`
`onGet`	(...`args`: `any`) => `void`
`name`	`string`
`namespace?`	`string`
`onError?`	(`err`: `ApiError` \| `null`, `cluster?`: `string`) => `void`
`opts?`	{ `cluster?`: `string`; `queryParams?`: `QueryParameters`; }
`opts.cluster?`	`string`
`opts.queryParams?`	`QueryParameters`

Returns

(...args: any[]) => Promise

Inherited from

KubeObject.apiGet

apiList()

static apiList<K>(
   this: (...args: any) => K & typeof KubeObject, 
   onList: (arg: K[]) => void, 
   onError?: (err: ApiError, cluster?: string) => void, 
   opts?: ApiListSingleNamespaceOptions): (...args: any[]) => Promise;

Defined in: lib/k8s/KubeObject.ts:264

Returns the API endpoint for this object.

Type Parameters

Type Parameter
`K` extends `KubeObject`<`any`>

Parameters

Parameter	Type	Description
`this`	(...`args`: `any`) => `K` & typeof `KubeObject`	-
`onList`	(`arg`: `K`[]) => `void`	Callback function to be called when the list is retrieved.
`onError?`	(`err`: `ApiError`, `cluster?`: `string`) => `void`	Callback function to be called when an error occurs.
`opts?`	`ApiListSingleNamespaceOptions`	Options to be passed to the API endpoint.

Returns

The API endpoint for this object.

(...args: any[]) => Promise

Inherited from

KubeObject.apiList

create()

static create<Args, T>(this: (...args: Args) => T, ...item: Args): T;

Defined in: lib/k8s/KubeObject.ts:440

Type Parameters

Type Parameter
`Args` extends `any`[]
`T` extends `KubeObject`<`any`>

Parameters

Parameter	Type
`this`	(...`args`: `Args`) => `T`
...`item`	`Args`

Returns

T

Inherited from

KubeObject.create

fetchAuthorization()

static fetchAuthorization(reqResourseAttrs?: AuthRequestResourceAttrs, cluster?: string): Promise<any>;

Defined in: lib/k8s/KubeObject.ts:615

Performs a request to check if the user has the given permission.

Parameters

Parameter	Type
`reqResourseAttrs?`	`AuthRequestResourceAttrs`
`cluster?`	`string`

Returns

Promise<any>

The result of the access request.

Inherited from

KubeObject.fetchAuthorization

getAuthorization()

static getAuthorization(
   verb: string, 
   reqResourseAttrs?: AuthRequestResourceAttrs, 
cluster?: string): Promise<any>;

Defined in: lib/k8s/KubeObject.ts:643

Parameters

Parameter	Type
`verb`	`string`
`reqResourseAttrs?`	`AuthRequestResourceAttrs`
`cluster?`	`string`

Returns

Promise<any>

Inherited from

KubeObject.getAuthorization

getBaseObject()

static getBaseObject(): KubePod;

Defined in: lib/k8s/pod.ts:533

Returns

KubePod

Overrides

KubeObject.getBaseObject

getErrorMessage()

static getErrorMessage(err: ApiError | null): "Error: Not found" | "Error: No permissions" | "Error" | null;

Defined in: lib/k8s/KubeObject.ts:719

Parameters

Parameter	Type
`err`	`ApiError` \| `null`

Returns

"Error: Not found" | "Error: No permissions" | "Error" | null

Inherited from

KubeObject.getErrorMessage

isClassOf()

static isClassOf<K>(this: K, maybeInstance: KubeObject): maybeInstance is InstanceType<K>;

Defined in: lib/k8s/KubeObject.ts:152

Type guard to check if a KubeObject instance belongs to this class. Compares API group name and kind to determine if the instance matches. This works even if class definitions are duplicated and should be used instead of instanceof.

Type Parameters

Type Parameter
`K` extends typeof `KubeObject`

Parameters

Parameter	Type	Description
`this`	`K`	-
`maybeInstance`	`KubeObject`	The KubeObject instance to check.

Returns

maybeInstance is InstanceType<K>

True if the instance is of this class type, with narrowed type.

Inherited from

KubeObject.isClassOf

put()

static put(data: KubeObjectInterface): Promise<KubeObjectInterface>;

Defined in: lib/k8s/KubeObject.ts:565

Parameters

Parameter	Type
`data`	`KubeObjectInterface`

Returns

Promise<KubeObjectInterface>

Inherited from

KubeObject.put

useApiGet()

static useApiGet<K>(
   this: (...args: any) => K & typeof KubeObject, 
   onGet: (item: K | null) => any, 
   name: string, 
   namespace?: string, 
   onError?: (err: ApiError | null, cluster?: string) => void, 
   opts?: object): void;

Defined in: lib/k8s/KubeObject.ts:472

Type Parameters

Type Parameter
`K` extends `KubeObject`<`any`>

Parameters

Parameter	Type
`this`	(...`args`: `any`) => `K` & typeof `KubeObject`
`onGet`	(`item`: `K` \| `null`) => `any`
`name`	`string`
`namespace?`	`string`
`onError?`	(`err`: `ApiError` \| `null`, `cluster?`: `string`) => `void`
`opts?`	{ `cluster?`: `string`; `queryParams?`: `QueryParameters`; }
`opts.cluster?`	`string`
`opts.queryParams?`	`QueryParameters`

Returns

void

Inherited from

KubeObject.useApiGet

useApiList()

static useApiList<K>(
   this: (...args: any) => K & typeof KubeObject, 
   onList: (...arg: any[]) => any, 
   onError?: (err: ApiError, cluster?: string) => void, 
   opts?: ApiListOptions): void;

Defined in: lib/k8s/KubeObject.ts:297

Type Parameters

Type Parameter
`K` extends `KubeObject`<`any`>

Parameters

Parameter	Type
`this`	(...`args`: `any`) => `K` & typeof `KubeObject`
`onList`	(...`arg`: `any`[]) => `any`
`onError?`	(`err`: `ApiError`, `cluster?`: `string`) => `void`
`opts?`	`ApiListOptions`

Returns

void

Inherited from

KubeObject.useApiList

useGet()

static useGet<K>(
   this: (...args: any) => K, 
   name: string, 
   namespace?: string, 
opts?: object): [K | null, ApiError | null] & QueryResponse<K, ApiError>;

Defined in: lib/k8s/KubeObject.ts:421

Type Parameters

Type Parameter
`K` extends `KubeObject`<`any`>

Parameters

Parameter	Type
`this`	(...`args`: `any`) => `K`
`name`	`string`
`namespace?`	`string`
`opts?`	{ `cluster?`: `string`; `queryParams?`: `QueryParameters`; }
`opts.cluster?`	`string`
`opts.queryParams?`	`QueryParameters`

Returns

[K | null, ApiError | null] & QueryResponse<K, ApiError>

Inherited from

KubeObject.useGet

useList()

static useList<K>(this: (...args: any) => K & typeof KubeObject, __namedParameters?: object & QueryParameters): [K[] | null, ApiError | null] & QueryListResponse<(
  | ListResponse<K>
  | null
| undefined)[], K, ApiError>;

Defined in: lib/k8s/KubeObject.ts:368

Type Parameters

Type Parameter
`K` extends `KubeObject`<`any`>

Parameters

Parameter	Type
`this`	(...`args`: `any`) => `K` & typeof `KubeObject`
`__namedParameters`	`object` & `QueryParameters`

Returns

Inherited from

KubeObject.useList

Class: Pod

Extends​

Constructors​

Constructor​

Parameters​

Returns​

Overrides​

Properties​

Accessors​

cluster​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

detailsRoute​

Get Signature​

Returns​

Inherited from​

isNamespaced​

Get Signature​

Returns​

Inherited from​

isScalable​

Get Signature​

Returns​

Inherited from​

kind​

Get Signature​

Returns​

Inherited from​

listRoute​

Get Signature​

Returns​

Inherited from​

metadata​

Get Signature​

Returns​

Inherited from​

pluralName​

Get Signature​

Returns​

Inherited from​

spec​

Get Signature​

Returns​

status​

Get Signature​

Returns​

conditions​

containerStatuses​

ephemeralContainerStatuses?​

hostIP?​

hostIPs?​

initContainerStatuses?​

message?​

nominatedNodeName?​

phase​

podIPs?​

qosClass?​

reason?​

startTime​

apiEndpoint​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

apiGroupName​

Get Signature​

Returns​

Inherited from​

className​

Get Signature​

Returns​

Inherited from​

detailsRoute​

Get Signature​

Extends

Constructors

Constructor

Parameters

Returns

Overrides

Properties

Accessors

cluster

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

detailsRoute

Get Signature

Returns

Inherited from

isNamespaced

Get Signature

Returns

Inherited from

isScalable

Get Signature

Returns

Inherited from

kind

Get Signature

Returns

Inherited from

listRoute

Get Signature

Returns

Inherited from

metadata

Get Signature

Returns

Inherited from

pluralName

Get Signature

Returns

Inherited from

spec

Get Signature

Returns

status

Get Signature

Returns

conditions

containerStatuses

ephemeralContainerStatuses?

hostIP?

hostIPs?

initContainerStatuses?

message?

nominatedNodeName?

phase

podIPs?

qosClass?

reason?

startTime

apiEndpoint

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

apiGroupName

Get Signature

Returns

Inherited from

className

Get Signature

Returns

Inherited from

detailsRoute

Get Signature

Returns