Skip to main content

Function: getCompositeDisruptionMode()

function getCompositeDisruptionMode(mode: 
| PodGroupDisruptionMode
| undefined): "Single" | "All" | undefined;

Defined in: lib/k8s/schedulingWorkload.ts:85

Human readable disruption mode of a composite template. The API describes it as one of Single or All: disrupt one child group at a time, or the whole composite together.

Parameters​

ParameterTypeDescription
mode| PodGroupDisruptionMode | undefinedThe disruptionMode field of a composite template.

Returns​

"Single" | "All" | undefined

'Single', 'All', or undefined when no mode is set.