Skip to main content

Class: Pod

Extends​

Constructors​

new Pod()​

new Pod(jsonData: KubePod): Pod

Parameters​

ParameterType
jsonDataKubePod

Returns​

Pod

Overrides​

KubeObject.constructor

Defined in​

src/lib/k8s/pod.ts:95

Properties​

PropertyModifierTypeDefault valueDescriptionOverridesInherited fromDefined in
_clusterNamepublicstringundefined--KubeObject._clusterNamesrc/lib/k8s/KubeObject.ts:29
jsonDatapublicKubePodundefined--KubeObject.jsonDatasrc/lib/k8s/KubeObject.ts:26
_internalApiEndpoint?staticApiClient<KubeObjectInterface> | ApiWithNamespaceClient<KubeObjectInterface>undefined--KubeObject._internalApiEndpointsrc/lib/k8s/KubeObject.ts:43
apiNamestaticstring'pods'Name of the resource, plural, used in APIKubeObject.apiName-src/lib/k8s/pod.ts:89
apiVersionstaticstring'v1'Group and version of the resource formatted as "GROUP/VERSION", e.g. "policy.k8s.io/v1".KubeObject.apiVersion-src/lib/k8s/pod.ts:90
isNamespacedstaticbooleantrueWhether the object is namespaced.KubeObject.isNamespaced-src/lib/k8s/pod.ts:91
kindstaticstring'Pod'The kind of the object. Corresponding to the resource kind in Kubernetes.KubeObject.kind-src/lib/k8s/pod.ts:88
readOnlyFieldsstaticstring[][]Readonly field defined as JSONPath paths-KubeObject.readOnlyFieldssrc/lib/k8s/KubeObject.ts:28

Accessors​

cluster​

get cluster(): string
set cluster(cluster: string): void

Parameters​

ParameterType
clusterstring

Returns​

string

Inherited from​

KubeObject.cluster

Defined in​

src/lib/k8s/KubeObject.ts:81


detailsRoute​

get detailsRoute(): string

Returns​

string

Inherited from​

KubeObject.detailsRoute

Defined in​

src/lib/k8s/KubeObject.ts:93


isNamespaced​

get isNamespaced(): boolean

Returns​

boolean

Inherited from​

KubeObject.isNamespaced

Defined in​

src/lib/k8s/KubeObject.ts:161


kind​

get kind(): any

Returns​

any

Inherited from​

KubeObject.kind

Defined in​

src/lib/k8s/KubeObject.ts:120


listRoute​

get listRoute(): string

Returns​

string

Inherited from​

KubeObject.listRoute

Defined in​

src/lib/k8s/KubeObject.ts:112


metadata​

get metadata(): KubeMetadata

Returns​

KubeMetadata

Inherited from​

KubeObject.metadata

Defined in​

src/lib/k8s/KubeObject.ts:157


pluralName​

get pluralName(): string

Returns​

string

Inherited from​

KubeObject.pluralName

Defined in​

src/lib/k8s/KubeObject.ts:107


spec​

get spec(): KubePodSpec

Returns​

KubePodSpec

Defined in​

src/lib/k8s/pod.ts:100


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


apiEndpoint​

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

Parameters​

ParameterType
endpointApiClient<KubeObjectInterface> | ApiWithNamespaceClient<KubeObjectInterface>

Returns​

ApiClient<KubeObjectInterface> | ApiWithNamespaceClient<KubeObjectInterface>

Inherited from​

KubeObject.apiEndpoint

Defined in​

src/lib/k8s/KubeObject.ts:45


className​

get static className(): string

Returns​

string

Inherited from​

KubeObject.className

Defined in​

src/lib/k8s/KubeObject.ts:89


detailsRoute​

get static detailsRoute(): string

Returns​

string

Inherited from​

KubeObject.detailsRoute

Defined in​

src/lib/k8s/KubeObject.ts:97


listRoute​

get static listRoute(): string

Returns​

string

Inherited from​

KubeObject.listRoute

Defined in​

src/lib/k8s/KubeObject.ts:116


pluralName​

get static pluralName(): string

Returns​

string

Inherited from​

KubeObject.pluralName

Defined in​

src/lib/k8s/KubeObject.ts:101

Methods​

_class()​

_class(): typeof KubeObject

Returns​

typeof KubeObject

Inherited from​

KubeObject._class

Defined in​

src/lib/k8s/KubeObject.ts:409


attach()​

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

Parameters​

ParameterType
containerstring
onAttachStreamResultsCb
optionsStreamArgs

Returns​

object

cancel()​
cancel: () => void;
Returns​

void

getSocket()​
getSocket: () => null | WebSocket;
Returns​

null | WebSocket

Defined in​

src/lib/k8s/pod.ts:174


delete()​

delete(): Promise<any>

Returns​

Promise<any>

Inherited from​

KubeObject.delete

Defined in​

src/lib/k8s/KubeObject.ts:413


exec()​

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

Parameters​

ParameterType
containerstring
onExecStreamResultsCb
optionsExecOptions

Returns​

object

cancel()​
cancel: () => void;
Returns​

void

getSocket()​
getSocket: () => null | WebSocket;
Returns​

null | WebSocket

Defined in​

src/lib/k8s/pod.ts:186


getAge()​

getAge(): string

Returns​

string

Inherited from​

KubeObject.getAge

Defined in​

src/lib/k8s/KubeObject.ts:149


getAuthorization()​

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

Parameters​

ParameterType
verbstring
reqResourseAttrs?AuthRequestResourceAttrs

Returns​

Promise<any>

Inherited from​

KubeObject.getAuthorization

Defined in​

src/lib/k8s/KubeObject.ts:559


getCreationTs()​

getCreationTs(): string

Returns​

string

Inherited from​

KubeObject.getCreationTs

Defined in​

src/lib/k8s/KubeObject.ts:145


getDetailedStatus()​

getDetailedStatus(): PodDetailedStatus

Returns​

PodDetailedStatus

Defined in​

src/lib/k8s/pod.ts:224


getDetailsLink(): string

Returns​

string

Inherited from​

KubeObject.getDetailsLink

Defined in​

src/lib/k8s/KubeObject.ts:124


getEditableObject()​

getEditableObject(): object

Returns​

object

Inherited from​

KubeObject.getEditableObject

Defined in​

src/lib/k8s/KubeObject.ts:165


getListLink(): string

Returns​

string

Inherited from​

KubeObject.getListLink

Defined in​

src/lib/k8s/KubeObject.ts:133


getLogs()​

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

Parameters​

ParameterType
...args[string, number, boolean, StreamResultsCb] | [string, StreamResultsCb, LogOptions]

Returns​

Function

Returns​

void

Defined in​

src/lib/k8s/pod.ts:108


getName()​

getName(): string

Returns​

string

Inherited from​

KubeObject.getName

Defined in​

src/lib/k8s/KubeObject.ts:137


getNamespace()​

getNamespace(): undefined | string

Returns​

undefined | string

Inherited from​

KubeObject.getNamespace

Defined in​

src/lib/k8s/KubeObject.ts:141


getValue()​

getValue(prop: string): any

Parameters​

ParameterType
propstring

Returns​

any

Inherited from​

KubeObject.getValue

Defined in​

src/lib/k8s/KubeObject.ts:153


patch()​

patch(body: OpPatch[]): Promise<any>

Parameters​

ParameterType
bodyOpPatch[]

Returns​

Promise<any>

Inherited from​

KubeObject.patch

Defined in​

src/lib/k8s/KubeObject.ts:460


scale()​

scale(numReplicas: number): Promise<any>

Parameters​

ParameterType
numReplicasnumber

Returns​

Promise<any>

Inherited from​

KubeObject.scale

Defined in​

src/lib/k8s/KubeObject.ts:431


update()​

update(data: KubeObjectInterface): Promise<KubeObjectInterface>

Parameters​

ParameterType
dataKubeObjectInterface

Returns​

Promise<KubeObjectInterface>

Inherited from​

KubeObject.update

Defined in​

src/lib/k8s/KubeObject.ts:423


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​

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

Returns​

Function

Parameters​
ParameterType
...argsany[]
Returns​

Promise<CancelFunction>

Inherited from​

KubeObject.apiGet

Defined in​

src/lib/k8s/KubeObject.ts:367


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​

ParameterTypeDescription
this(...args: any) => K & typeof KubeObject-
onList(arg: K[]) => voidCallback function to be called when the list is retrieved.
onError?(err: ApiError, cluster?: string) => voidCallback function to be called when an error occurs.
opts?ApiListSingleNamespaceOptionsOptions to be passed to the API endpoint.

Returns​

Function

The API endpoint for this object.

Parameters​
ParameterType
...argsany[]
Returns​

Promise<CancelFunction>

Inherited from​

KubeObject.apiList

Defined in​

src/lib/k8s/KubeObject.ts:195


create()​

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

Type Parameters​

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

Parameters​

ParameterType
this(...args: Args) => T
...itemArgs

Returns​

T

Inherited from​

KubeObject.create

Defined in​

src/lib/k8s/KubeObject.ts:360


fetchAuthorization()​

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

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

Parameters​

ParameterType
reqResourseAttrs?AuthRequestResourceAttrs

Returns​

Promise<any>

The result of the access request.

Inherited from​

KubeObject.fetchAuthorization

Defined in​

src/lib/k8s/KubeObject.ts:477


getAuthorization()​

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

Parameters​

ParameterType
verbstring
reqResourseAttrs?AuthRequestResourceAttrs

Returns​

Promise<any>

Inherited from​

KubeObject.getAuthorization

Defined in​

src/lib/k8s/KubeObject.ts:504


getErrorMessage()​

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

Parameters​

ParameterType
errnull | ApiError

Returns​

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

Inherited from​

KubeObject.getErrorMessage

Defined in​

src/lib/k8s/KubeObject.ts:588


put()​

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

Parameters​

ParameterType
dataKubeObjectInterface

Returns​

Promise<KubeObjectInterface>

Inherited from​

KubeObject.put

Defined in​

src/lib/k8s/KubeObject.ts:427


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​

ParameterType
this(...args: any) => K & typeof KubeObject
onGet(item: null | K) => any
namestring
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:392


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​

ParameterType
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:228


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​

ParameterType
this(...args: any) => K
namestring
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:342


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​

ParameterType
this(...args: any) => K & typeof KubeObject
__namedParametersobject & QueryParameters

Returns​

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

Inherited from​

KubeObject.useList

Defined in​

src/lib/k8s/KubeObject.ts:297