Class: Pod

Extends

• KubeObject<KubePod>

Constructors

new Pod()

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

Parameters

Parameter	Type
jsonData	KubePod
cluster?	string

Returns

Pod

Overrides

KubeObject.constructor

Defined in

src/lib/k8s/pod.ts:119

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
_clusterName	public	string	undefined	-	-	KubeObject._clusterName	src/lib/k8s/KubeObject.ts:52
jsonData	public	KubePod	undefined	-	-	KubeObject.jsonData	src/lib/k8s/KubeObject.ts:49
_internalApiEndpoint?	static	ApiClient<KubeObjectInterface> | ApiWithNamespaceClient<KubeObjectInterface>	undefined	-	-	KubeObject._internalApiEndpoint	src/lib/k8s/KubeObject.ts:66
apiName	static	string	'pods'	Name of the resource, plural, used in API	KubeObject.apiName	-	src/lib/k8s/pod.ts:113
apiVersion	static	string	'v1'	Group and version of the resource formatted as "GROUP/VERSION", e.g. "policy.k8s.io/v1".	KubeObject.apiVersion	-	src/lib/k8s/pod.ts:114
isNamespaced	static	boolean	true	Whether the object is namespaced.	KubeObject.isNamespaced	-	src/lib/k8s/pod.ts:115
kind	static	string	'Pod'	The kind of the object. Corresponding to the resource kind in Kubernetes.	KubeObject.kind	-	src/lib/k8s/pod.ts:112
readOnlyFields	static	string[]	[]	Readonly field defined as JSONPath paths	-	KubeObject.readOnlyFields	src/lib/k8s/KubeObject.ts:51

Accessors

cluster

get cluster(): string

set cluster(cluster: string): void

Parameters

Parameter	Type
cluster	string

Returns

string

Inherited from

KubeObject.cluster

Defined in

src/lib/k8s/KubeObject.ts:104

---

detailsRoute

get detailsRoute(): string

Returns

string

Inherited from

KubeObject.detailsRoute

Defined in

src/lib/k8s/KubeObject.ts:116

---

isNamespaced

get isNamespaced(): boolean

Returns

boolean

Inherited from

KubeObject.isNamespaced

Defined in

src/lib/k8s/KubeObject.ts:189

---

kind

get kind(): any

Returns

any

Inherited from

KubeObject.kind

Defined in

src/lib/k8s/KubeObject.ts:143

---

listRoute

get listRoute(): string

Returns

string

Inherited from

KubeObject.listRoute

Defined in

src/lib/k8s/KubeObject.ts:135

---

metadata

get metadata(): KubeMetadata

Returns

KubeMetadata

Inherited from

KubeObject.metadata

Defined in

src/lib/k8s/KubeObject.ts:185

---

pluralName

get pluralName(): string

Returns

string

Inherited from

KubeObject.pluralName

Defined in

src/lib/k8s/KubeObject.ts:130

---

spec

get spec(): KubePodSpec

Returns

KubePodSpec

Defined in

src/lib/k8s/pod.ts:124

---

status

get status(): object

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;

phase

phase: string;

podIPs?

optional podIPs: object[];

qosClass?

optional qosClass: string;

reason?

optional reason: string;

startTime

startTime: Time;

Defined in

src/lib/k8s/pod.ts:128

---

apiEndpoint

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

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

Parameters

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

Returns

ApiClient<KubeObjectInterface> | ApiWithNamespaceClient<KubeObjectInterface>

Inherited from

KubeObject.apiEndpoint

Defined in

src/lib/k8s/KubeObject.ts:68

---

className

get static className(): string

Returns

string

Inherited from

KubeObject.className

Defined in

src/lib/k8s/KubeObject.ts:112

---

detailsRoute

get static detailsRoute(): string

Returns

string

Inherited from

KubeObject.detailsRoute

Defined in

src/lib/k8s/KubeObject.ts:120

---

listRoute

get static listRoute(): string

Returns

string

Inherited from

KubeObject.listRoute

Defined in

src/lib/k8s/KubeObject.ts:139

---

pluralName

get static pluralName(): string

Returns

string

Inherited from

KubeObject.pluralName

Defined in

src/lib/k8s/KubeObject.ts:124

Methods

_class()

_class(): typeof KubeObject

Returns

typeof KubeObject

Inherited from

KubeObject._class

Defined in

src/lib/k8s/KubeObject.ts:441

---

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:256

---

delete()

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

Parameters

Parameter	Type
force?	boolean

Returns

Promise<any>

Inherited from

KubeObject.delete

Defined in

src/lib/k8s/KubeObject.ts:445

---

evict()

evict(): Promise<any>

Returns

Promise<any>

Defined in

src/lib/k8s/pod.ts:132

---

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:273

---

getAge()

getAge(): string

Returns

string

Inherited from

KubeObject.getAge

Defined in

src/lib/k8s/KubeObject.ts:177

---

getAuthorization()

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

Parameters

Parameter	Type
verb	string
reqResourseAttrs?	AuthRequestResourceAttrs

Returns

Promise<any>

Inherited from

KubeObject.getAuthorization

Defined in

src/lib/k8s/KubeObject.ts:591

---

getCreationTs()

getCreationTs(): string

Returns

string

Inherited from

KubeObject.getCreationTs

Defined in

src/lib/k8s/KubeObject.ts:173

---

getDetailedStatus()

getDetailedStatus(): PodDetailedStatus

Returns

PodDetailedStatus

Defined in

src/lib/k8s/pod.ts:316

---

getDetailsLink()

getDetailsLink(): string

Returns

string

Inherited from

KubeObject.getDetailsLink

Defined in

src/lib/k8s/KubeObject.ts:147

---

getEditableObject()

getEditableObject(): object

Returns

object

Inherited from

KubeObject.getEditableObject

Defined in

src/lib/k8s/KubeObject.ts:193

---

getListLink()

getListLink(): string

Returns

string

Inherited from

KubeObject.getListLink

Defined in

src/lib/k8s/KubeObject.ts:161

---

getLogs()

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

Parameters

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

Returns

Function

Returns

void

Defined in

src/lib/k8s/pod.ts:142

---

getName()

getName(): string

Returns

string

Inherited from

KubeObject.getName

Defined in

src/lib/k8s/KubeObject.ts:165

---

getNamespace()

getNamespace(): undefined | string

Returns

undefined | string

Inherited from

KubeObject.getNamespace

Defined in

src/lib/k8s/KubeObject.ts:169

---

getValue()

getValue(prop: string): any

Parameters

Parameter	Type
prop	string

Returns

any

Inherited from

KubeObject.getValue

Defined in

src/lib/k8s/KubeObject.ts:181

---

patch()

patch(body: RecursivePartial<KubePod>): Promise<any>

Parameters

Parameter	Type
body	RecursivePartial<KubePod>

Returns

Promise<any>

Inherited from

KubeObject.patch

Defined in

src/lib/k8s/KubeObject.ts:499

---

scale()

scale(numReplicas: number): Promise<any>

Parameters

Parameter	Type
numReplicas	number

Returns

Promise<any>

Inherited from

KubeObject.scale

Defined in

src/lib/k8s/KubeObject.ts:470

---

update()

update(data: KubeObjectInterface): Promise<KubeObjectInterface>

Parameters

Parameter	Type
data	KubeObjectInterface

Returns

Promise<KubeObjectInterface>

Inherited from

KubeObject.update

Defined in

src/lib/k8s/KubeObject.ts:462

---

apiGet()

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

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: null | ApiError, cluster?: string) => void
opts?	object
opts.cluster?	string
opts.queryParams?	QueryParameters

Returns

Function

Parameters

Parameter	Type
...args	any[]

Returns

Promise<CancelFunction>

Inherited from

KubeObject.apiGet

Defined in

src/lib/k8s/KubeObject.ts:399

---

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<CancelFunction>

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

Function

The API endpoint for this object.

Parameters

Parameter	Type
...args	any[]

Returns

Promise<CancelFunction>

Inherited from

KubeObject.apiList

Defined in

src/lib/k8s/KubeObject.ts:223

---

create()

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

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

Defined in

src/lib/k8s/KubeObject.ts:392

---

fetchAuthorization()

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

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

Defined in

src/lib/k8s/KubeObject.ts:516

---

getAuthorization()

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

Parameters

Parameter	Type
verb	string
reqResourseAttrs?	AuthRequestResourceAttrs
cluster?	string

Returns

Promise<any>

Inherited from

KubeObject.getAuthorization

Defined in

src/lib/k8s/KubeObject.ts:544

---

getBaseObject()

static getBaseObject(): KubePod

Returns

KubePod

Overrides

KubeObject.getBaseObject

Defined in

src/lib/k8s/pod.ts:439

---

getErrorMessage()

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

Parameters

Parameter	Type
err	null | ApiError

Returns

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

Inherited from

KubeObject.getErrorMessage

Defined in

src/lib/k8s/KubeObject.ts:620

---

put()

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

Parameters

Parameter	Type
data	KubeObjectInterface

Returns

Promise<KubeObjectInterface>

Inherited from

KubeObject.put

Defined in

src/lib/k8s/KubeObject.ts:466

---

useApiGet()

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

Type Parameters

Type Parameter
K extends KubeObject<any>

Parameters

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

Returns

void

Inherited from

KubeObject.useApiGet

Defined in

src/lib/k8s/KubeObject.ts:424

---

useApiList()

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

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

Defined in

src/lib/k8s/KubeObject.ts:256

---

useGet()

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

Type Parameters

Type Parameter
K extends KubeObject<any>

Parameters

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

Returns

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

Inherited from

KubeObject.useGet

Defined in

src/lib/k8s/KubeObject.ts:374

---

useList()

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

Type Parameters

Type Parameter
K extends KubeObject<any>

Parameters

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

Returns

[null | K[], null | ApiError] & QueryListResponse<(undefined | null | ListResponse<K>)[], K, ApiError>

Inherited from

KubeObject.useList

Defined in

src/lib/k8s/KubeObject.ts:325