Class: CompositePodGroup

Defined in: lib/k8s/compositePodGroup.ts:93

Extends

• KubeObject<KubeCompositePodGroup>

Constructors

Constructor

new CompositePodGroup(json: KubeCompositePodGroup, cluster?: string): CompositePodGroup;

Defined in: lib/k8s/KubeObject.ts:109

Parameters

Parameter	Type
json	KubeCompositePodGroup
cluster?	string

Returns

CompositePodGroup

Inherited from

KubeObject.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
_clusterName	public	string	undefined	-	-	KubeObject._clusterName	lib/k8s/KubeObject.ts:59
jsonData	public	KubeCompositePodGroup	undefined	-	-	KubeObject.jsonData	lib/k8s/KubeObject.ts:56
_internalApiEndpoint?	static	| ApiClient<KubeObjectInterface> | ApiWithNamespaceClient<KubeObjectInterface>	undefined	-	-	KubeObject._internalApiEndpoint	lib/k8s/KubeObject.ts:76
apiName	static	string	'compositepodgroups'	Name of the resource, plural, used in API	KubeObject.apiName	-	lib/k8s/compositePodGroup.ts:95
apiVersion	static	string[]	undefined	Only v1alpha3 serves this resource. v1beta1 serves the composite templates within a Workload, but not the groups they are instantiated into.	KubeObject.apiVersion	-	lib/k8s/compositePodGroup.ts:100
isNamespaced	static	boolean	true	Whether the object is namespaced.	KubeObject.isNamespaced	-	lib/k8s/compositePodGroup.ts:101
isScalable	readonly	boolean	undefined	Whether the object is scalable, and should have a ScaleButton	-	KubeObject.isScalable	lib/k8s/KubeObject.ts:74
kind	static	string	'CompositePodGroup'	The kind of the object. Corresponding to the resource kind in Kubernetes.	KubeObject.kind	-	lib/k8s/compositePodGroup.ts:94
readOnlyFields	static	string[]	[]	Readonly field defined as JSONPath paths	-	KubeObject.readOnlyFields	lib/k8s/KubeObject.ts:58

Accessors

cluster

Get Signature

get cluster(): string;

Defined in: lib/k8s/KubeObject.ts:114

Returns

string

Set Signature

set cluster(cluster: string): void;

Defined in: lib/k8s/KubeObject.ts:118

Parameters

Parameter	Type
cluster	string

Returns

void

Inherited from

KubeObject.cluster

---

compositePodGroupTemplateName

Get Signature

get compositePodGroupTemplateName(): string | undefined;

Defined in: lib/k8s/compositePodGroup.ts:141

Name of the template within the Workload this group was created from, if any.

Returns

string | undefined

---

detailsRoute

Get Signature

get detailsRoute(): string;

Defined in: lib/k8s/KubeObject.ts:126

Returns

string

Inherited from

KubeObject.detailsRoute

---

disruptionMode

Get Signature

get disruptionMode(): "Single" | "All" | undefined;

Defined in: lib/k8s/compositePodGroup.ts:151

Whether a disruption affects one child group at a time, or the whole composite.

Returns

"Single" | "All" | undefined

---

isNamespaced

Get Signature

get isNamespaced(): boolean;

Defined in: lib/k8s/KubeObject.ts:235

Returns

boolean

Inherited from

KubeObject.isNamespaced

---

isScalable

Get Signature

get isScalable(): boolean;

Defined in: lib/k8s/KubeObject.ts:239

Returns

boolean

Inherited from

KubeObject.isScalable

---

kind

Get Signature

get kind(): any;

Defined in: lib/k8s/KubeObject.ts:189

Returns

any

Inherited from

KubeObject.kind

---

listRoute

Get Signature

get listRoute(): string;

Defined in: lib/k8s/KubeObject.ts:181

Returns

string

Inherited from

KubeObject.listRoute

---

metadata

Get Signature

get metadata(): KubeMetadata;

Defined in: lib/k8s/KubeObject.ts:231

Returns

KubeMetadata

Inherited from

KubeObject.metadata

---

minGroupCount

Get Signature

get minGroupCount(): number | undefined;

Defined in: lib/k8s/compositePodGroup.ts:131

Child groups that must be schedulable together, when the gang policy is used.

Returns

number | undefined

---

parentCompositePodGroupName

Get Signature

get parentCompositePodGroupName(): string | undefined;

Defined in: lib/k8s/compositePodGroup.ts:146

The composite group this one is nested in, when it is not a hierarchy root.

Returns

string | undefined

---

pluralName

Get Signature

get pluralName(): string;

Defined in: lib/k8s/KubeObject.ts:176

Returns

string

Inherited from

KubeObject.pluralName

---

policyKind

Get Signature

get policyKind(): string | undefined;

Defined in: lib/k8s/compositePodGroup.ts:126

Which scheduling policy this group uses, e.g. 'Gang' or 'Basic'.

Returns

string | undefined

---

schedulingCondition

Get Signature

get schedulingCondition(): 
  | KubeCondition
  | undefined;

Defined in: lib/k8s/compositePodGroup.ts:155

Returns

| KubeCondition | undefined

---

spec

Get Signature

get spec(): CompositePodGroupSpec;

Defined in: lib/k8s/compositePodGroup.ts:117

Returns

CompositePodGroupSpec

---

status

Get Signature

get status(): 
  | {
  conditions?: KubeCondition[];
}
  | undefined;

Defined in: lib/k8s/compositePodGroup.ts:121

Returns

| { conditions?: KubeCondition[]; } | undefined

---

workloadName

Get Signature

get workloadName(): string | undefined;

Defined in: lib/k8s/compositePodGroup.ts:136

Name of the Workload this group was templated from, if any.

Returns

string | undefined

---

apiEndpoint

Get Signature

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

Defined in: lib/k8s/KubeObject.ts:78

Returns

| ApiClient<KubeObjectInterface> | ApiWithNamespaceClient<KubeObjectInterface>

Set Signature

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

Defined in: lib/k8s/KubeObject.ts:105

Parameters

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

Returns

void

Inherited from

KubeObject.apiEndpoint

---

apiGroupName

Get Signature

get static apiGroupName(): string | undefined;

Defined in: lib/k8s/KubeObject.ts:142

Get name of the API group of this resource for example will return batch for CronJob

For core group, like Pods, it will return undefined

API group reference https://kubernetes.io/docs/reference/using-api/#api-groups

Returns

string | undefined

Inherited from

KubeObject.apiGroupName

---

className

Get Signature

get static className(): string;

Defined in: lib/k8s/KubeObject.ts:122

Returns

string

Inherited from

KubeObject.className

---

detailsRoute

Get Signature

get static detailsRoute(): string;

Defined in: lib/k8s/KubeObject.ts:130

Returns

string

Inherited from

KubeObject.detailsRoute

---

listRoute

Get Signature

get static listRoute(): string;

Defined in: lib/k8s/KubeObject.ts:185

Returns

string

Inherited from

KubeObject.listRoute

---

pluralName

Get Signature

get static pluralName(): string;

Defined in: lib/k8s/KubeObject.ts:170

Returns

string

Inherited from

KubeObject.pluralName

Methods

_class()

_class(): typeof KubeObject;

Defined in: lib/k8s/KubeObject.ts:534

Returns

typeof KubeObject

Inherited from

KubeObject._class

---

delete()

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

Defined in: lib/k8s/KubeObject.ts:538

Parameters

Parameter	Type
force?	boolean

Returns

Promise<any>

Inherited from

KubeObject.delete

---

getAge()

getAge(): string;

Defined in: lib/k8s/KubeObject.ts:223

Returns

string

Inherited from

KubeObject.getAge

---

getAuthorization()

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

Defined in: lib/k8s/KubeObject.ts:734

Parameters

Parameter	Type
verb	string
reqResourseAttrs?	AuthRequestResourceAttrs

Returns

Promise<any>

Inherited from

KubeObject.getAuthorization

---

getCreationTs()

getCreationTs(): string;

Defined in: lib/k8s/KubeObject.ts:219

Returns

string

Inherited from

KubeObject.getCreationTs

---

getDetailsLink()

getDetailsLink(): string;

Defined in: lib/k8s/KubeObject.ts:193

Returns

string

Inherited from

KubeObject.getDetailsLink

---

getEditableObject()

getEditableObject(): object;

Defined in: lib/k8s/KubeObject.ts:243

Returns

object

Inherited from

KubeObject.getEditableObject

---

getListLink()

getListLink(): string;

Defined in: lib/k8s/KubeObject.ts:207

Returns

string

Inherited from

KubeObject.getListLink

---

getName()

getName(): string;

Defined in: lib/k8s/KubeObject.ts:211

Returns

string

Inherited from

KubeObject.getName

---

getNamespace()

getNamespace(): string | undefined;

Defined in: lib/k8s/KubeObject.ts:215

Returns

string | undefined

Inherited from

KubeObject.getNamespace

---

getValue()

getValue(prop: string): any;

Defined in: lib/k8s/KubeObject.ts:227

Parameters

Parameter	Type
prop	string

Returns

any

Inherited from

KubeObject.getValue

---

patch()

patch(body: RecursivePartial<T>): Promise<any>;

Defined in: lib/k8s/KubeObject.ts:642

Parameters

Parameter	Type
body	RecursivePartial<T>

Returns

Promise<any>

Inherited from

KubeObject.patch

---

patchUpdate()

patchUpdate(original: KubeObjectInterface, modified: KubeObjectInterface): Promise<KubeObjectInterface>;

Defined in: lib/k8s/KubeObject.ts:566

Updates a resource using JSON Patch (RFC 6902), sending only the diff between the original and modified objects. This avoids 409 Conflict errors on resources that are frequently updated by controllers (e.g. HPA).

Parameters

Parameter	Type
original	KubeObjectInterface
modified	KubeObjectInterface

Returns

Promise<KubeObjectInterface>

Inherited from

KubeObject.patchUpdate

---

scale()

scale(numReplicas: number): Promise<any>;

Defined in: lib/k8s/KubeObject.ts:613

Parameters

Parameter	Type
numReplicas	number

Returns

Promise<any>

Inherited from

KubeObject.scale

---

update()

update(data: KubeObjectInterface): Promise<KubeObjectInterface>;

Defined in: lib/k8s/KubeObject.ts:557

Parameters

Parameter	Type
data	KubeObjectInterface

Returns

Promise<KubeObjectInterface>

Inherited from

KubeObject.update

---

apiGet()

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

Defined in: lib/k8s/KubeObject.ts:491

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

Returns

(...args: any[]) => Promise

Inherited from

KubeObject.apiGet

---

apiList()

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

Defined in: lib/k8s/KubeObject.ts:273

Builds a list request for this object's API endpoint.

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

A parameterless function that starts the list request and resolves to a CancelFunction for stopping it.

() => Promise<CancelFunction>

Inherited from

KubeObject.apiList

---

create()

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

Defined in: lib/k8s/KubeObject.ts:484

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

---

fetchAuthorization()

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

Defined in: lib/k8s/KubeObject.ts:659

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

---

getAuthorization()

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

Defined in: lib/k8s/KubeObject.ts:687

Parameters

Parameter	Type
verb	string
reqResourseAttrs?	AuthRequestResourceAttrs
cluster?	string

Returns

Promise<any>

Inherited from

KubeObject.getAuthorization

---

getBaseObject()

static getBaseObject(): Omit<KubeObjectInterface, "metadata"> & object;

Defined in: lib/k8s/KubeObject.ts:778

Returns

Omit<KubeObjectInterface, "metadata"> & object

Inherited from

KubeObject.getBaseObject

---

getErrorMessage()

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

Defined in: lib/k8s/KubeObject.ts:763

Parameters

Parameter	Type
err	ApiError | null

Returns

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

Inherited from

KubeObject.getErrorMessage

---

isClassOf()

static isClassOf<K>(this: K, maybeInstance: KubeObject): maybeInstance is InstanceType<K>;

Defined in: lib/k8s/KubeObject.ts:161

Type guard to check if a KubeObject instance belongs to this class. Compares API group name and kind to determine if the instance matches. This works even if class definitions are duplicated and should be used instead of instanceof.

Type Parameters

Type Parameter
K extends typeof KubeObject

Parameters

Parameter	Type	Description
this	K	-
maybeInstance	KubeObject	The KubeObject instance to check.

Returns

maybeInstance is InstanceType<K>

True if the instance is of this class type, with narrowed type.

Inherited from

KubeObject.isClassOf

---

isEnabled()

static isEnabled(cluster: string): Promise<boolean>;

Defined in: lib/k8s/compositePodGroup.ts:109

Whether the cluster serves this resource, which requires the CompositePodGroup feature gate to be enabled on top of the ones the flat scheduling APIs need.

Parameters

Parameter	Type	Description
cluster	string	The cluster to check.

Returns

Promise<boolean>

true when the CompositePodGroup resource is served.

---

put()

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

Defined in: lib/k8s/KubeObject.ts:609

Parameters

Parameter	Type
data	KubeObjectInterface

Returns

Promise<KubeObjectInterface>

Inherited from

KubeObject.put

---

useApiGet()

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

Defined in: lib/k8s/KubeObject.ts:516

Type Parameters

Type Parameter
K extends KubeObject<any>

Parameters

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

Returns

void

Inherited from

KubeObject.useApiGet

---

useApiList()

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

Defined in: lib/k8s/KubeObject.ts:308

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

---

useGet()

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

Defined in: lib/k8s/KubeObject.ts:463

Type Parameters

Type Parameter
K extends KubeObject<any>

Parameters

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

Returns

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

Inherited from

KubeObject.useGet

---

useList()

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

Defined in: lib/k8s/KubeObject.ts:379

Type Parameters

Type Parameter
K extends KubeObject<any>

Parameters

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

Returns

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

Inherited from

KubeObject.useList