Class: Pod
lib/k8s/pod .Pod
Hierarchy
-
any
↳
Pod
Constructors
constructor
• new Pod(jsonData
)
Parameters
Name | Type |
---|---|
jsonData |
KubePod
|
Overrides
makeKubeObject<KubePod>('Pod').constructor
Defined in
Properties
apiEndpoint
▪ Static
apiEndpoint: Object
Index signature
▪ [other: string
]: any
Type declaration
Name | Type |
---|---|
scale? |
{ get : (namespace : string , name : string ) => Promise <any > ; put : (body : { metadata :
KubeMetadata
; spec : { replicas : number } }) => Promise <any > } |
scale.get |
(namespace : string , name : string ) => Promise <any > |
scale.put |
(body : { metadata :
KubeMetadata
; spec : { replicas : number } }) => Promise <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
[] |
initContainers? |
any [] |
nodeName |
string |
nodeSelector? |
{ [key: string] : string ; } |
Defined in
status
• get
status(): Object
Returns
Object
Name | Type |
---|---|
conditions |
KubeCondition
[] |
containerStatuses |
KubeContainerStatus
[] |
hostIP |
string |
initContainerStatuses? |
KubeContainerStatus
[] |
message? |
string |
phase |
string |
qosClass? |
string |
reason? |
string |
startTime |
Time
|
Defined in
Methods
attach
▸ attach(container
, onAttach
, options?
): Object
Parameters
Name | Type |
---|---|
container |
string |
onAttach |
StreamResultsCb
|
options |
StreamArgs
|
Returns
Object
Name | Type |
---|---|
cancel |
() => void |
getSocket |
() => null | WebSocket |
Defined in
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
getDetailedStatus
▸ getDetailedStatus(): PodDetailedStatus
Returns
PodDetailedStatus
Defined in
getLogs
▸ getLogs(…args
): () => void
Parameters
Name | Type |
---|---|
...args |
[container: string, tailLines: number, showPrevious: boolean, onLogs: StreamResultsCb] | [container: string, onLogs: StreamResultsCb, logsOptions: LogOptions] |
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
getAuthorization
▸ Static
Optional
getAuthorization(arg
, resourceAttrs?
): any
Parameters
Name | Type |
---|---|
arg |
string |
resourceAttrs? |
AuthRequestResourceAttrs
|
Returns
any
Inherited from
makeKubeObject<KubePod>(‘Pod’).getAuthorization
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
useGet
▸ Static
useGet(name
, namespace?
): [any
, null
|
ApiError
, (item
: any
) => void
, (err
: null
|
ApiError
) => void
]
Parameters
Name | Type |
---|---|
name |
string |
namespace? |
string |
Returns
[any
, null
|
ApiError
, (item
: any
) => void
, (err
: null
|
ApiError
) => void
]
Inherited from
makeKubeObject<KubePod>(‘Pod’).useGet
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