Class: Event

Defined in: lib/k8s/event.ts:44

Extends

• KubeObject<KubeEvent>

Constructors

Constructor

new Event(json: KubeEvent, cluster?: string): Event;

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

Parameters

Parameter	Type
json	KubeEvent
cluster?	string

Returns

Event

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:50
jsonData	public	KubeEvent	undefined	-	-	KubeObject.jsonData	lib/k8s/KubeObject.ts:47
_internalApiEndpoint?	static	| ApiClient<KubeObjectInterface> | ApiWithNamespaceClient<KubeObjectInterface>	undefined	-	-	KubeObject._internalApiEndpoint	lib/k8s/KubeObject.ts:67
apiName	static	string	'events'	Name of the resource, plural, used in API	KubeObject.apiName	-	lib/k8s/event.ts:46
apiVersion	static	string	'v1'	Group and version of the resource formatted as "GROUP/VERSION", e.g. "policy.k8s.io/v1".	KubeObject.apiVersion	-	lib/k8s/event.ts:47
isNamespaced	static	boolean	true	Whether the object is namespaced.	KubeObject.isNamespaced	-	lib/k8s/event.ts:49
isScalable	readonly	boolean	undefined	Whether the object is scalable, and should have a ScaleButton	-	KubeObject.isScalable	lib/k8s/KubeObject.ts:65
kind	static	string	'Event'	The kind of the object. Corresponding to the resource kind in Kubernetes.	KubeObject.kind	-	lib/k8s/event.ts:45
readOnlyFields	static	string[]	[]	Readonly field defined as JSONPath paths	-	KubeObject.readOnlyFields	lib/k8s/KubeObject.ts:49

Accessors

cluster

Get Signature

get cluster(): string;

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

Returns

string

Set Signature

set cluster(cluster: string): void;

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

Parameters

Parameter	Type
cluster	string

Returns

void

Inherited from

KubeObject.cluster

---

count

Get Signature

get count(): any;

Defined in: lib/k8s/event.ts:92

Returns

any

---

detailsRoute

Get Signature

get detailsRoute(): string;

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

Returns

string

Inherited from

KubeObject.detailsRoute

---

firstOccurrence

Get Signature

get firstOccurrence(): any;

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

Returns

any

---

involvedObject

Get Signature

get involvedObject(): any;

Defined in: lib/k8s/event.ts:72

Returns

any

---

involvedObjectInstance

Get Signature

get involvedObjectInstance(): KubeObject<any> | null;

Defined in: lib/k8s/event.ts:172

Returns

KubeObject<any> | null

---

isNamespaced

Get Signature

get isNamespaced(): boolean;

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

Returns

boolean

Inherited from

KubeObject.isNamespaced

---

isScalable

Get Signature

get isScalable(): boolean;

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

Returns

boolean

Inherited from

KubeObject.isScalable

---

kind

Get Signature

get kind(): any;

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

Returns

any

Inherited from

KubeObject.kind

---

lastOccurrence

Get Signature

get lastOccurrence(): any;

Defined in: lib/k8s/event.ts:101

Returns

any

---

listRoute

Get Signature

get listRoute(): string;

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

Returns

string

Inherited from

KubeObject.listRoute

---

message

Get Signature

get message(): any;

Defined in: lib/k8s/event.ts:84

Returns

any

---

metadata

Get Signature

get metadata(): KubeMetadata;

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

Returns

KubeMetadata

Inherited from

KubeObject.metadata

---

pluralName

Get Signature

get pluralName(): string;

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

Returns

string

Inherited from

KubeObject.pluralName

---

reason

Get Signature

get reason(): any;

Defined in: lib/k8s/event.ts:80

Returns

any

---

source

Get Signature

get source(): any;

Defined in: lib/k8s/event.ts:88

Returns

any

---

spec

Get Signature

get spec(): any;

Defined in: lib/k8s/event.ts:64

Returns

any

---

status

Get Signature

get status(): any;

Defined in: lib/k8s/event.ts:68

Returns

any

---

type

Get Signature

get type(): any;

Defined in: lib/k8s/event.ts:76

Returns

any

---

apiEndpoint

Get Signature

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

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

Returns

| ApiClient<KubeObjectInterface> | ApiWithNamespaceClient<KubeObjectInterface>

Set Signature

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

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

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

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

Returns

string

Inherited from

KubeObject.className

---

detailsRoute

Get Signature

get static detailsRoute(): string;

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

Returns

string

Inherited from

KubeObject.detailsRoute

---

listRoute

Get Signature

get static listRoute(): string;

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

Returns

string

Inherited from

KubeObject.listRoute

---

maxLimit

Get Signature

get static maxLimit(): number;

Defined in: lib/k8s/event.ts:55

Returns

number

Set Signature

set static maxLimit(limit: number): void;

Defined in: lib/k8s/event.ts:60

Parameters

Parameter	Type
limit	number

Returns

void

---

pluralName

Get Signature

get static pluralName(): string;

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

Returns

string

Inherited from

KubeObject.pluralName

Methods

_class()

_class(): typeof KubeObject;

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

Returns

typeof KubeObject

Inherited from

KubeObject._class

---

delete()

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

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

Parameters

Parameter	Type
force?	boolean

Returns

Promise<any>

Inherited from

KubeObject.delete

---

getAge()

getAge(): string;

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

Returns

string

Inherited from

KubeObject.getAge

---

getAuthorization()

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

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

Parameters

Parameter	Type
verb	string
reqResourseAttrs?	AuthRequestResourceAttrs

Returns

Promise<any>

Inherited from

KubeObject.getAuthorization

---

getCreationTs()

getCreationTs(): string;

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

Returns

string

Inherited from

KubeObject.getCreationTs

---

getDetailsLink()

getDetailsLink(): string;

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

Returns

string

Inherited from

KubeObject.getDetailsLink

---

getEditableObject()

getEditableObject(): object;

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

Returns

object

Inherited from

KubeObject.getEditableObject

---

getListLink()

getListLink(): string;

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

Returns

string

Inherited from

KubeObject.getListLink

---

getName()

getName(): string;

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

Returns

string

Inherited from

KubeObject.getName

---

getNamespace()

getNamespace(): string | undefined;

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

Returns

string | undefined

Inherited from

KubeObject.getNamespace

---

getValue()

getValue(prop: string): any;

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

Parameters

Parameter	Type
prop	string

Returns

any

Inherited from

KubeObject.getValue

---

patch()

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

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

Parameters

Parameter	Type
body	RecursivePartial<T>

Returns

Promise<any>

Inherited from

KubeObject.patch

---

scale()

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

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

Parameters

Parameter	Type
numReplicas	number

Returns

Promise<any>

Inherited from

KubeObject.scale

---

update()

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

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

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

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): (...args: any[]) => Promise;

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

Returns the API endpoint for this object.

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

The API endpoint for this object.

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

Inherited from

KubeObject.apiList

---

create()

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

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

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

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

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

Returns

Omit<KubeObjectInterface, "metadata"> & object

Inherited from

KubeObject.getBaseObject

---

getErrorMessage()

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

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

Parameters

Parameter	Type
err	ApiError | null

Returns

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

Inherited from

KubeObject.getErrorMessage

---

isClassOf()

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

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

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

---

objectEvents()

static objectEvents(object: KubeObject): Promise<any>;

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

Parameters

Parameter	Type
object	KubeObject

Returns

Promise<any>

---

put()

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

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

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

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

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

Type Parameters

Type Parameter
K extends KubeObject<any>

Parameters

Parameter	Type
this	(...args: any) => K
name	string
namespace?	string
opts?	{ cluster?: string; queryParams?: QueryParameters; }
opts.cluster?	string
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:365

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

---

useListForClusters()

static useListForClusters(clusterNames: string[], options?: object): EventsPerCluster;

Defined in: lib/k8s/event.ts:206

Fetch events for given clusters

Important! Make sure to have the parent component have clusters as a key so that component remounts when clusters change, instead of rerendering with different number of clusters

Parameters

Parameter	Type
clusterNames	string[]
options	{ queryParams?: QueryParameters; }
options.queryParams?	QueryParameters

Returns

EventsPerCluster

---

useWarningList()

static useWarningList(clusters: string[], options?: object): EventsPerCluster;

Defined in: lib/k8s/event.ts:256

Fetch warning events for given clusters Amount is limited to Event.maxEventsLimit

Important! Make sure to have the parent component have clusters as a key so that component remounts when clusters change, instead of rerendering with different number of clusters

Parameters

Parameter	Type
clusters	string[]
options?	{ queryParams?: QueryParameters; }
options.queryParams?	QueryParameters

Returns

EventsPerCluster