Class: Pod
lib/k8s/pod .Pod
Hierarchy
-
any
↳
Pod
Constructors
constructor
• new Pod(json
)
Parameters
Name | Type |
---|---|
json |
KubePod
|
Inherited from
makeKubeObject<KubePod>(‘Pod’).constructor
Defined in
Properties
apiEndpoint
▪ Static
apiEndpoint: Object
Index signature
▪ [other: string
]: any
Defined in
className
▪ Static
className: string
Inherited from
makeKubeObject<KubePod>(‘Pod’).className
Defined in
Accessors
spec
• get
spec(): Object
Returns
Object
Name | Type |
---|---|
containers |
KubeContainer
[] |
nodeName |
string |
Defined in
status
• get
status(): Object
Returns
Object
Name | Type |
---|---|
conditions |
KubeCondition
[] |
containerStatuses |
KubeContainerStatus
[] |
hostIP |
string |
message |
string |
phase |
string |
qosClass |
string |
reason |
string |
startTime |
number |
Defined in
Methods
exec
▸ exec(container
, onExec
, options?
): Object
Parameters
Name | Type |
---|---|
container |
string |
onExec |
StreamResultsCb
|
options |
ExecOptions
|
Returns
Object
Name | Type |
---|---|
cancel |
() => void |
getSocket |
() => null | WebSocket |
Defined in
getLogs
▸ getLogs(container
, tailLines
, showPrevious
, onLogs
): () => void
Parameters
Name | Type |
---|---|
container |
string |
tailLines |
number |
showPrevious |
boolean |
onLogs |
StreamResultsCb
|
Returns
fn
▸ (): void
Returns
void
Defined in
apiList
▸ Static
apiList(onList
): any
Parameters
Name | Type |
---|---|
onList |
(arg : any []) => void |
Returns
any
Inherited from
makeKubeObject<KubePod>(‘Pod’).apiList
Defined in
getErrorMessage
▸ Static
getErrorMessage(err?
): null
| string
Parameters
Name | Type |
---|---|
err? |
null |
ApiError
|
Returns
null
| string
Inherited from
makeKubeObject<KubePod>(‘Pod’).getErrorMessage
Defined in
useApiGet
▸ Static
useApiGet(onGet
, name
, namespace?
, onError?
): void
Parameters
Name | Type |
---|---|
onGet |
(…args : any ) => void |
name |
string |
namespace? |
string |
onError? |
(err :
ApiError
) => void |
Returns
void
Inherited from
makeKubeObject<KubePod>(‘Pod’).useApiGet
Defined in
useApiList
▸ Static
useApiList(onList
, onError?
, opts?
): any
Parameters
Name | Type |
---|---|
onList |
(arg : any []) => void |
onError? |
(err :
ApiError
) => void |
opts? |
ApiListOptions
|
Returns
any
Inherited from
makeKubeObject<KubePod>(‘Pod’).useApiList
Defined in
useList
▸ Static
useList(opts?
): [any
[], null
|
ApiError
, (items
: any
[]) => void
, (err
: null
|
ApiError
) => void
]
Parameters
Name | Type |
---|---|
opts? |
ApiListOptions
|
Returns
[any
[], null
|
ApiError
, (items
: any
[]) => void
, (err
: null
|
ApiError
) => void
]
Inherited from
makeKubeObject<KubePod>(‘Pod’).useList