Class: Pod

Extends

• any

Constructors

new Pod()

new Pod(jsonData: KubePod): Pod

Parameters

Parameter	Type
jsonData	KubePod

Returns

Pod

Overrides

makeKubeObject<KubePod>('Pod').constructor

Defined in

src/lib/k8s/pod.ts:93

Properties

Property	Modifier	Type	Inherited from	Defined in
apiEndpoint	static	ApiWithNamespaceClient<KubeObjectInterface>	-	src/lib/k8s/pod.ts:90
apiList	static	(onList: (arg: any[]) => void, onError?: (err: ApiError) => void, opts?: ApiListSingleNamespaceOptions) => any	makeKubeObject<KubePod>('Pod').apiList	src/lib/k8s/cluster.ts:311
className	static	string	makeKubeObject<KubePod>('Pod').className	src/lib/k8s/cluster.ts:338
getAuthorization?	static	(arg: string, resourceAttrs?: AuthRequestResourceAttrs) => any	makeKubeObject<KubePod>('Pod').getAuthorization	src/lib/k8s/cluster.ts:340
getErrorMessage	static	(err?: null | ApiError) => null | string	makeKubeObject<KubePod>('Pod').getErrorMessage	src/lib/k8s/cluster.ts:336
useApiGet	static	(onGet: (...args: any) => void, name: string, namespace?: string, onError?: (err: ApiError) => void) => void	makeKubeObject<KubePod>('Pod').useApiGet	src/lib/k8s/cluster.ts:321
useApiList	static	(onList: (arg: any[]) => void, onError?: (err: ApiError) => void, opts?: ApiListOptions) => any	makeKubeObject<KubePod>('Pod').useApiList	src/lib/k8s/cluster.ts:316
useGet	static	(name: string, namespace?: string, opts?: object) => [any, null | ApiError] & QueryResponse<any, ApiError>	makeKubeObject<KubePod>('Pod').useGet	src/lib/k8s/cluster.ts:328

Accessors

spec

get spec(): KubePodSpec

Returns

KubePodSpec

Defined in

src/lib/k8s/pod.ts:98

---

status

get status(): object

Returns

object

conditions

conditions: KubeCondition[];

containerStatuses

containerStatuses: KubeContainerStatus[];

ephemeralContainerStatuses?

optional ephemeralContainerStatuses: KubeContainerStatus[];

hostIP?

optional hostIP: string;

initContainerStatuses?

optional initContainerStatuses: KubeContainerStatus[];

message?

optional message: string;

phase

phase: string;

qosClass?

optional qosClass: string;

reason?

optional reason: string;

startTime

startTime: Time;

Defined in

src/lib/k8s/pod.ts:102

Methods

attach()

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

Parameters

Parameter	Type
container	string
onAttach	StreamResultsCb
options	StreamArgs

Returns

object

cancel()

cancel: () => void;

Returns

void

getSocket()

getSocket: () => null | WebSocket;

Returns

null | WebSocket

Defined in

src/lib/k8s/pod.ts:172

---

exec()

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

Parameters

Parameter	Type
container	string
onExec	StreamResultsCb
options	ExecOptions

Returns

object

cancel()

cancel: () => void;

Returns

void

getSocket()

getSocket: () => null | WebSocket;

Returns

null | WebSocket

Defined in

src/lib/k8s/pod.ts:184

---

getDetailedStatus()

getDetailedStatus(): PodDetailedStatus

Returns

PodDetailedStatus

Defined in

src/lib/k8s/pod.ts:222

---

getLogs()

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

Parameters

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

Returns

Function

Returns

void

Defined in

src/lib/k8s/pod.ts:106

---

useList()

static useList(options?: ApiListOptions): [null | any[], null | ApiError] & QueryListResponse<KubeList<any>, any, ApiError>

Parameters

Parameter	Type
options?	ApiListOptions

Returns

[null | any[], null | ApiError] & QueryListResponse<KubeList<any>, any, ApiError>

Inherited from

makeKubeObject<KubePod>('Pod').useList

Defined in

src/lib/k8s/cluster.ts:327