Class: VolumeClaimStore

Renderer.K8sApi.VolumeClaimStore

Hierarchy

• KubeObjectStore<PersistentVolumeClaim, PersistentVolumeClaimApi>

↳ VolumeClaimStore

Table of contents

Constructors

• constructor

Properties

• api
• bufferSize
• defaultSorting
• dependencies
• eventsBuffer
• failedLoading
• isLoaded
• isLoading
• items
• limit
• selectedItemsIds

Accessors

• contextItems
• query
• selectedItems

Methods

• [iterator]
• bindWatchEventsUpdater
• create
• createItem
• 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 VolumeClaimStore(dependencies, api, opts?)

Parameters

Name	Type
dependencies	KubeObjectStoreDependencies
api	PersistentVolumeClaimApi
opts?	KubeObjectStoreOptions

Inherited from

KubeObjectStore<PersistentVolumeClaim, PersistentVolumeClaimApi>.constructor

Properties

api

• Readonly api: PersistentVolumeClaimApi

Inherited from

KubeObjectStore.api

---

bufferSize

• Readonly bufferSize: number

Inherited from

KubeObjectStore.bufferSize

---

defaultSorting

• Protected defaultSorting: (item: PersistentVolumeClaim) => string

Type declaration

▸ (item): string

Parameters

Name	Type
item	PersistentVolumeClaim

Returns

string

Inherited from

KubeObjectStore.defaultSorting

---

dependencies

• Protected Readonly dependencies: KubeObjectStoreDependencies

Inherited from

KubeObjectStore.dependencies

---

eventsBuffer

• Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, PersistentVolumeClaimStatus, PersistentVolumeClaimSpec>>>

Inherited from

KubeObjectStore.eventsBuffer

---

failedLoading

• failedLoading: boolean

Inherited from

KubeObjectStore.failedLoading

---

isLoaded

• isLoaded: boolean

Inherited from

KubeObjectStore.isLoaded

---

isLoading

• isLoading: boolean

Inherited from

KubeObjectStore.isLoading

---

items

• items: IObservableArray<PersistentVolumeClaim>

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<PersistentVolumeClaim, void, undefined>

Returns

Generator<PersistentVolumeClaim, void, undefined>

Inherited from

KubeObjectStore.__@iterator@50

---

bindWatchEventsUpdater

▸ Protected bindWatchEventsUpdater(delay?): void

Parameters

Name	Type
delay?	number

Returns

void

Inherited from

KubeObjectStore.bindWatchEventsUpdater

---

create

▸ create(params, data?): Promise<PersistentVolumeClaim>

Parameters

Name	Type
params	Object
params.name	string
params.namespace?	string
data?	PartialObjectDeep<PersistentVolumeClaim, {}>

Returns

Promise<PersistentVolumeClaim>

Inherited from

KubeObjectStore.create

---

createItem

▸ Protected createItem(params, data?): Promise<null | PersistentVolumeClaim>

Parameters

Name	Type
params	Object
params.name	string
params.namespace?	string
data?	PartialObjectDeep<PersistentVolumeClaim, {}>

Returns

Promise<null | PersistentVolumeClaim>

Inherited from

KubeObjectStore.createItem

---

filterItemsOnLoad

▸ Protected filterItemsOnLoad(items): PersistentVolumeClaim[]

Parameters

Name	Type
items	PersistentVolumeClaim[]

Returns

PersistentVolumeClaim[]

Inherited from

KubeObjectStore.filterItemsOnLoad

---

getAllByNs

▸ getAllByNs(namespace, strict?): PersistentVolumeClaim[]

Parameters

Name	Type
namespace	string | string[]
strict?	boolean

Returns

PersistentVolumeClaim[]

Inherited from

KubeObjectStore.getAllByNs

---

getById

▸ getById(id): undefined | PersistentVolumeClaim

Parameters

Name	Type
id	string

Returns

undefined | PersistentVolumeClaim

Inherited from

KubeObjectStore.getById

---

getByLabel

▸ getByLabel(labels): PersistentVolumeClaim[]

Parameters

Name	Type
labels	string[] | Partial<Record<string, string>>

Returns

PersistentVolumeClaim[]

Inherited from

KubeObjectStore.getByLabel

---

getByName

▸ getByName(name, namespace?): undefined | PersistentVolumeClaim

Parameters

Name	Type
name	string
namespace?	string

Returns

undefined | PersistentVolumeClaim

Inherited from

KubeObjectStore.getByName

---

getByPath

▸ getByPath(path): undefined | PersistentVolumeClaim

Parameters

Name	Type
path	string

Returns

undefined | PersistentVolumeClaim

Inherited from

KubeObjectStore.getByPath

---

getIndexById

▸ getIndexById(id): number

Parameters

Name	Type
id	string

Returns

number

Inherited from

KubeObjectStore.getIndexById

---

getItems

▸ getItems(): PersistentVolumeClaim[]

Returns

PersistentVolumeClaim[]

Inherited from

KubeObjectStore.getItems

---

getTotalCount

▸ getTotalCount(): number

Returns

number

Inherited from

KubeObjectStore.getTotalCount

---

isSelected

▸ isSelected(item): boolean

Parameters

Name	Type
item	PersistentVolumeClaim

Returns

boolean

Inherited from

KubeObjectStore.isSelected

---

isSelectedAll

▸ isSelectedAll(visibleItems?): boolean

Parameters

Name	Type
visibleItems?	PersistentVolumeClaim[]

Returns

boolean

Inherited from

KubeObjectStore.isSelectedAll

---

load

▸ load(params): Promise<PersistentVolumeClaim>

Parameters

Name	Type
params	Object
params.name	string
params.namespace?	string

Returns

Promise<PersistentVolumeClaim>

Inherited from

KubeObjectStore.load

---

loadAll

▸ loadAll(«destructured»?): Promise<undefined | PersistentVolumeClaim[]>

Parameters

Name	Type
«destructured»	KubeObjectStoreLoadAllParams

Returns

Promise<undefined | PersistentVolumeClaim[]>

Inherited from

KubeObjectStore.loadAll

---

loadFromPath

▸ loadFromPath(resourcePath): Promise<PersistentVolumeClaim>

Parameters

Name	Type
resourcePath	string

Returns

Promise<PersistentVolumeClaim>

Inherited from

KubeObjectStore.loadFromPath

---

loadItem

▸ Protected loadItem(params): Promise<null | PersistentVolumeClaim>

Parameters

Name	Type
params	Object
params.name	string
params.namespace?	string

Returns

Promise<null | PersistentVolumeClaim>

Inherited from

KubeObjectStore.loadItem

---

loadItems

▸ Protected loadItems(«destructured»): Promise<PersistentVolumeClaim[]>

Parameters

Name	Type
«destructured»	KubeObjectStoreLoadingParams

Returns

Promise<PersistentVolumeClaim[]>

Inherited from

KubeObjectStore.loadItems

---

mergeItems

▸ Protected mergeItems(partialItems, «destructured»): PersistentVolumeClaim[]

Parameters

Name	Type
partialItems	PersistentVolumeClaim[]
«destructured»	MergeItemsOptions

Returns

PersistentVolumeClaim[]

Inherited from

KubeObjectStore.mergeItems

---

patch

▸ patch(item, patch): Promise<PersistentVolumeClaim>

Parameters

Name	Type
item	PersistentVolumeClaim
patch	Patch

Returns

Promise<PersistentVolumeClaim>

Inherited from

KubeObjectStore.patch

---

pickOnlySelected

▸ pickOnlySelected(items): PersistentVolumeClaim[]

Parameters

Name	Type
items	PersistentVolumeClaim[]

Returns

PersistentVolumeClaim[]

Inherited from

KubeObjectStore.pickOnlySelected

---

reloadAll

▸ reloadAll(opts?): Promise<undefined | PersistentVolumeClaim[]>

Parameters

Name	Type
opts?	Object
opts.force?	boolean
opts.merge?	boolean
opts.namespaces?	string[]

Returns

Promise<undefined | PersistentVolumeClaim[]>

Inherited from

KubeObjectStore.reloadAll

---

remove

▸ remove(item): Promise<void>

Parameters

Name	Type
item	PersistentVolumeClaim

Returns

Promise<void>

Inherited from

KubeObjectStore.remove

---

removeItem

▸ Protected removeItem(item, request): Promise<void>

Parameters

Name	Type
item	PersistentVolumeClaim
request	() => Promise<any>

Returns

Promise<void>

Inherited from

KubeObjectStore.removeItem

---

removeItems

▸ removeItems(items): Promise<void>

Parameters

Name	Type
items	PersistentVolumeClaim[]

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	PersistentVolumeClaim

Returns

void

Inherited from

KubeObjectStore.select

---

sortItems

▸ Protected sortItems(items?, sorting?, order?): PersistentVolumeClaim[]

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?	PersistentVolumeClaim[]	the items to be sorted (default: the current items in this store)
sorting?	(item: PersistentVolumeClaim) => 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

PersistentVolumeClaim[]

Inherited from

KubeObjectStore.sortItems

---

subscribe

▸ subscribe(«destructured»?): Disposer

Parameters

Name	Type
«destructured»	KubeObjectStoreSubscribeParams

Returns

Disposer

Inherited from

KubeObjectStore.subscribe

---

toggleSelection

▸ toggleSelection(item): void

Parameters

Name	Type
item	PersistentVolumeClaim

Returns

void

Inherited from

KubeObjectStore.toggleSelection

---

toggleSelectionAll

▸ toggleSelectionAll(visibleItems?): void

Parameters

Name	Type
visibleItems?	PersistentVolumeClaim[]

Returns

void

Inherited from

KubeObjectStore.toggleSelectionAll

---

unselect

▸ unselect(item): void

Parameters

Name	Type
item	PersistentVolumeClaim

Returns

void

Inherited from

KubeObjectStore.unselect

---

update

▸ update(item, data): Promise<PersistentVolumeClaim>

Parameters

Name	Type
item	PersistentVolumeClaim
data	PartialObjectDeep<PersistentVolumeClaim, {}>

Returns

Promise<PersistentVolumeClaim>

Inherited from

KubeObjectStore.update

---

updateFromEventsBuffer

▸ Protected updateFromEventsBuffer(): void

Returns

void

Inherited from

KubeObjectStore.updateFromEventsBuffer

---

updateItem

▸ Protected updateItem(item, request): Promise<PersistentVolumeClaim>

Parameters

Name	Type
item	PersistentVolumeClaim
request	() => Promise<PersistentVolumeClaim>

Returns

Promise<PersistentVolumeClaim>

Inherited from

KubeObjectStore.updateItem