Class: IngressClassStore#
+Renderer.K8sApi.IngressClassStore
+Hierarchy#
+-
+
KubeObjectStore<IngressClass,IngressClassApi>
+
↳ IngressClassStore
Table of contents#
+Constructors#
+-
+
- constructor +
Properties#
+-
+
- api +
- bufferSize +
- dependencies +
- eventsBuffer +
- failedLoading +
- isLoaded +
- isLoading +
- items +
- limit +
- selectedItemsIds +
Accessors#
+ +Methods#
+-
+
- [iterator] +
- bindWatchEventsUpdater +
- create +
- createItem +
- defaultSorting +
- filterItemsOnLoad +
- getAllByNs +
- getById +
- getByLabel +
- getByName +
- getByPath +
- getIndexById +
- getItems +
- getTotalCount +
- isSelected +
- isSelectedAll +
- load +
- loadAll +
- loadFromPath +
- loadItem +
- loadItems +
- mergeItems +
- patch +
- pickOnlySelected +
- reloadAll +
- remove +
- removeItem +
- removeItems +
- removeSelectedItems +
- reset +
- resetOnError +
- resetSelection +
- select +
- sortItems +
- subscribe +
- toggleSelection +
- toggleSelectionAll +
- unselect +
- update +
- updateFromEventsBuffer +
- updateItem +
Constructors#
+constructor#
+• new IngressClassStore(dependencies, api, opts?)
Parameters#
+| Name | +Type | +
|---|---|
dependencies |
+KubeObjectStoreDependencies |
+
api |
+IngressClassApi |
+
opts? |
+KubeObjectStoreOptions |
+
Inherited from#
+KubeObjectStore<IngressClass, IngressClassApi>.constructor
+Properties#
+api#
+• Readonly api: IngressClassApi
Inherited from#
+KubeObjectStore.api
++
bufferSize#
+• Readonly bufferSize: number
Inherited from#
+KubeObjectStore.bufferSize
++
dependencies#
+• Protected Readonly dependencies: KubeObjectStoreDependencies
Inherited from#
+KubeObjectStore.dependencies
++
eventsBuffer#
+• Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<IngressClassMetadata, IngressClassStatus, IngressClassSpec>>>
Inherited from#
+KubeObjectStore.eventsBuffer
++
failedLoading#
+• failedLoading: boolean = false
Inherited from#
+KubeObjectStore.failedLoading
++
isLoaded#
+• isLoaded: boolean = false
Inherited from#
+KubeObjectStore.isLoaded
++
isLoading#
+• isLoading: boolean = false
Inherited from#
+KubeObjectStore.isLoading
++
items#
+• items: IObservableArray<IngressClass>
Inherited from#
+KubeObjectStore.items
++
limit#
+• Readonly limit: undefined | number
Inherited from#
+KubeObjectStore.limit
++
selectedItemsIds#
+• selectedItemsIds: ObservableSet<string>
Inherited from#
+KubeObjectStore.selectedItemsIds
+Accessors#
+contextItems#
+• get contextItems(): K[]
Returns#
+K[]
Inherited from#
+KubeObjectStore.contextItems
++
query#
+• get query(): KubeApiQueryParams
Returns#
+KubeApiQueryParams
Inherited from#
+KubeObjectStore.query
++
selectedItems#
+• get selectedItems(): Item[]
Returns#
+Item[]
Inherited from#
+KubeObjectStore.selectedItems
+Methods#
+[iterator]#
+▸ [iterator](): Generator<IngressClass, void, undefined>
Returns#
+Generator<IngressClass, void, undefined>
Inherited from#
+KubeObjectStore.__@iterator@212
++
bindWatchEventsUpdater#
+▸ Protected bindWatchEventsUpdater(delay?): void
Parameters#
+| Name | +Type | +Default value | +
|---|---|---|
delay |
+number |
+1000 |
+
Returns#
+void
Inherited from#
+KubeObjectStore.bindWatchEventsUpdater
++
create#
+▸ create(params, data?): Promise<IngressClass>
Parameters#
+| Name | +Type | +
|---|---|
params |
+Object |
+
params.name |
+string |
+
params.namespace? |
+string |
+
data? |
+PartialObjectDeep<IngressClass> |
+
Returns#
+Promise<IngressClass>
Inherited from#
+KubeObjectStore.create
++
createItem#
+▸ Protected createItem(params, data?): Promise<null | IngressClass>
Parameters#
+| Name | +Type | +
|---|---|
params |
+Object |
+
params.name |
+string |
+
params.namespace? |
+string |
+
data? |
+PartialObjectDeep<IngressClass> |
+
Returns#
+Promise<null | IngressClass>
Inherited from#
+KubeObjectStore.createItem
++
defaultSorting#
+▸ Protected defaultSorting(item): string
Parameters#
+| Name | +Type | +
|---|---|
item |
+Item |
+
Returns#
+string
Inherited from#
+KubeObjectStore.defaultSorting
++
filterItemsOnLoad#
+▸ Protected filterItemsOnLoad(items): IngressClass[]
Parameters#
+| Name | +Type | +
|---|---|
items |
+IngressClass[] |
+
Returns#
+IngressClass[]
Inherited from#
+KubeObjectStore.filterItemsOnLoad
++
getAllByNs#
+▸ getAllByNs(namespace, strict?): IngressClass[]
Parameters#
+| Name | +Type | +Default value | +
|---|---|---|
namespace |
+string | string[] |
+undefined |
+
strict |
+boolean |
+false |
+
Returns#
+IngressClass[]
Inherited from#
+KubeObjectStore.getAllByNs
++
getById#
+▸ getById(id): undefined | IngressClass
Parameters#
+| Name | +Type | +
|---|---|
id |
+string |
+
Returns#
+undefined | IngressClass
Inherited from#
+KubeObjectStore.getById
++
getByLabel#
+▸ getByLabel(labels): IngressClass[]
Parameters#
+| Name | +Type | +
|---|---|
labels |
+string[] | Partial<Record<string, string>> |
+
Returns#
+IngressClass[]
Inherited from#
+KubeObjectStore.getByLabel
++
getByName#
+▸ getByName(name, namespace?): undefined | IngressClass
Parameters#
+| Name | +Type | +
|---|---|
name |
+string |
+
namespace? |
+string |
+
Returns#
+undefined | IngressClass
Inherited from#
+KubeObjectStore.getByName
++
getByPath#
+▸ getByPath(path): undefined | IngressClass
Parameters#
+| Name | +Type | +
|---|---|
path |
+string |
+
Returns#
+undefined | IngressClass
Inherited from#
+KubeObjectStore.getByPath
++
getIndexById#
+▸ getIndexById(id): number
Parameters#
+| Name | +Type | +
|---|---|
id |
+string |
+
Returns#
+number
Inherited from#
+KubeObjectStore.getIndexById
++
getItems#
+▸ getItems(): IngressClass[]
Returns#
+IngressClass[]
Inherited from#
+KubeObjectStore.getItems
++
getTotalCount#
+▸ getTotalCount(): number
Returns#
+number
Inherited from#
+KubeObjectStore.getTotalCount
++
isSelected#
+▸ isSelected(item): boolean
Parameters#
+| Name | +Type | +
|---|---|
item |
+IngressClass |
+
Returns#
+boolean
Inherited from#
+KubeObjectStore.isSelected
++
isSelectedAll#
+▸ isSelectedAll(visibleItems?): boolean
Parameters#
+| Name | +Type | +
|---|---|
visibleItems |
+IngressClass[] |
+
Returns#
+boolean
Inherited from#
+KubeObjectStore.isSelectedAll
++
load#
+▸ load(params): Promise<IngressClass>
Parameters#
+| Name | +Type | +
|---|---|
params |
+Object |
+
params.name |
+string |
+
params.namespace? |
+string |
+
Returns#
+Promise<IngressClass>
Inherited from#
+KubeObjectStore.load
++
loadAll#
+▸ loadAll(__namedParameters?): Promise<undefined | IngressClass[]>
Parameters#
+| Name | +Type | +
|---|---|
__namedParameters |
+KubeObjectStoreLoadAllParams |
+
Returns#
+Promise<undefined | IngressClass[]>
Inherited from#
+KubeObjectStore.loadAll
++
loadFromPath#
+▸ loadFromPath(resourcePath): Promise<IngressClass>
Parameters#
+| Name | +Type | +
|---|---|
resourcePath |
+string |
+
Returns#
+Promise<IngressClass>
Inherited from#
+KubeObjectStore.loadFromPath
++
loadItem#
+▸ Protected loadItem(params): Promise<null | IngressClass>
Parameters#
+| Name | +Type | +
|---|---|
params |
+Object |
+
params.name |
+string |
+
params.namespace? |
+string |
+
Returns#
+Promise<null | IngressClass>
Inherited from#
+KubeObjectStore.loadItem
++
loadItems#
+▸ Protected loadItems(__namedParameters): Promise<IngressClass[]>
Parameters#
+| Name | +Type | +
|---|---|
__namedParameters |
+KubeObjectStoreLoadingParams |
+
Returns#
+Promise<IngressClass[]>
Inherited from#
+KubeObjectStore.loadItems
++
mergeItems#
+▸ Protected mergeItems(partialItems, __namedParameters): IngressClass[]
Parameters#
+| Name | +Type | +
|---|---|
partialItems |
+IngressClass[] |
+
__namedParameters |
+MergeItemsOptions |
+
Returns#
+IngressClass[]
Inherited from#
+KubeObjectStore.mergeItems
++
patch#
+▸ patch(item, patch): Promise<IngressClass>
Parameters#
+| Name | +Type | +
|---|---|
item |
+IngressClass |
+
patch |
+Patch |
+
Returns#
+Promise<IngressClass>
Inherited from#
+KubeObjectStore.patch
++
pickOnlySelected#
+▸ pickOnlySelected(items): IngressClass[]
Parameters#
+| Name | +Type | +
|---|---|
items |
+IngressClass[] |
+
Returns#
+IngressClass[]
Inherited from#
+KubeObjectStore.pickOnlySelected
++
reloadAll#
+▸ reloadAll(opts?): Promise<undefined | IngressClass[]>
Parameters#
+| Name | +Type | +
|---|---|
opts |
+Object |
+
opts.force? |
+boolean |
+
opts.merge? |
+boolean |
+
opts.namespaces? |
+string[] |
+
Returns#
+Promise<undefined | IngressClass[]>
Inherited from#
+KubeObjectStore.reloadAll
++
remove#
+▸ remove(item): Promise<void>
Parameters#
+| Name | +Type | +
|---|---|
item |
+IngressClass |
+
Returns#
+Promise<void>
Inherited from#
+KubeObjectStore.remove
++
removeItem#
+▸ Protected removeItem(item, request): Promise<void>
Parameters#
+| Name | +Type | +
|---|---|
item |
+IngressClass |
+
request |
+() => Promise<any> |
+
Returns#
+Promise<void>
Inherited from#
+KubeObjectStore.removeItem
++
removeItems#
+▸ removeItems(items): Promise<void>
Parameters#
+| Name | +Type | +
|---|---|
items |
+IngressClass[] |
+
Returns#
+Promise<void>
Inherited from#
+KubeObjectStore.removeItems
++
removeSelectedItems#
+▸ removeSelectedItems(): Promise<void>
Returns#
+Promise<void>
Inherited from#
+KubeObjectStore.removeSelectedItems
++
reset#
+▸ reset(): void
Returns#
+void
Inherited from#
+KubeObjectStore.reset
++
resetOnError#
+▸ Protected resetOnError(error): void
Parameters#
+| Name | +Type | +
|---|---|
error |
+any |
+
Returns#
+void
Inherited from#
+KubeObjectStore.resetOnError
++
resetSelection#
+▸ resetSelection(): void
Returns#
+void
Inherited from#
+KubeObjectStore.resetSelection
++
select#
+▸ select(item): void
Parameters#
+| Name | +Type | +
|---|---|
item |
+IngressClass |
+
Returns#
+void
Inherited from#
+KubeObjectStore.select
++
sortItems#
+▸ Protected sortItems(items?, sorting?, order?): IngressClass[]
Return items sorted by the given ordering functions. If two elements of
+items are sorted to the same "index" then the next sorting function is used
+to determine where to place them relative to each other. Once the sorting
+functions have been all exhausted then the order is unchanged (ie a stable sort).
Parameters#
+| Name | +Type | +Description | +
|---|---|---|
items |
+IngressClass[] |
+the items to be sorted (default: the current items in this store) | +
sorting |
+(item: IngressClass) => any[] |
+list of functions to determine sort order (default: sorting by name) | +
order? |
+"asc" | "desc" |
+whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc") |
+
Returns#
+IngressClass[]
Inherited from#
+KubeObjectStore.sortItems
++
subscribe#
+▸ subscribe(__namedParameters?): Disposer
Parameters#
+| Name | +Type | +
|---|---|
__namedParameters |
+KubeObjectStoreSubscribeParams |
+
Returns#
+Disposer
Inherited from#
+KubeObjectStore.subscribe
++
toggleSelection#
+▸ toggleSelection(item): void
Parameters#
+| Name | +Type | +
|---|---|
item |
+IngressClass |
+
Returns#
+void
Inherited from#
+KubeObjectStore.toggleSelection
++
toggleSelectionAll#
+▸ toggleSelectionAll(visibleItems?): void
Parameters#
+| Name | +Type | +
|---|---|
visibleItems |
+IngressClass[] |
+
Returns#
+void
Inherited from#
+KubeObjectStore.toggleSelectionAll
++
unselect#
+▸ unselect(item): void
Parameters#
+| Name | +Type | +
|---|---|
item |
+IngressClass |
+
Returns#
+void
Inherited from#
+KubeObjectStore.unselect
++
update#
+▸ update(item, data): Promise<IngressClass>
Parameters#
+| Name | +Type | +
|---|---|
item |
+IngressClass |
+
data |
+PartialObjectDeep<IngressClass> |
+
Returns#
+Promise<IngressClass>
Inherited from#
+KubeObjectStore.update
++
updateFromEventsBuffer#
+▸ Protected updateFromEventsBuffer(): void
Returns#
+void
Inherited from#
+KubeObjectStore.updateFromEventsBuffer
++
updateItem#
+▸ Protected updateItem(item, request): Promise<IngressClass>
Parameters#
+| Name | +Type | +
|---|---|
item |
+IngressClass |
+
request |
+() => Promise<IngressClass> |
+
Returns#
+Promise<IngressClass>
Inherited from#
+KubeObjectStore.updateItem
+ + + + + + + +