Skip to content

Class: PersistentVolumesStore#

Renderer.K8sApi.PersistentVolumesStore

Hierarchy#

PersistentVolumesStore

Table of contents#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

new PersistentVolumesStore(api, opts?)

Parameters#

Name Type
api PersistentVolumeApi
opts? KubeObjectStoreOptions

Inherited from#

KubeObjectStore.constructor

new PersistentVolumesStore()

deprecated Supply API instance through constructor

Inherited from#

KubeObjectStore.constructor

Properties#

api#

Readonly api: PersistentVolumeApi

Inherited from#

KubeObjectStore.api


bufferSize#

Readonly bufferSize: number

Inherited from#

KubeObjectStore.bufferSize


eventsBuffer#

Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, PersistentVolumeStatus, PersistentVolumeSpec>>>

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<PersistentVolume>

Inherited from#

KubeObjectStore.items


limit#

Readonly limit: undefined | number

Inherited from#

KubeObjectStore.limit


selectedItemsIds#

selectedItemsIds: ObservableSet<string>

Inherited from#

KubeObjectStore.selectedItemsIds


defaultContext#

Static Readonly defaultContext: IObservableValue<undefined | ClusterContext>

Inherited from#

KubeObjectStore.defaultContext

Accessors#

context#

get context(): undefined | ClusterContext

Returns#

undefined | ClusterContext

Inherited from#

KubeObjectStore.context


contextItems#

get contextItems(): K[]

Returns#

K[]

Inherited from#

KubeObjectStore.contextItems


contextReady#

get contextReady(): Promise<void> & { cancel: () => void }

Returns#

Promise<void> & { cancel: () => void }

Inherited from#

KubeObjectStore.contextReady


namespacesReady#

get namespacesReady(): Promise<void> & { cancel: () => void }

Returns#

Promise<void> & { cancel: () => void }

Inherited from#

KubeObjectStore.namespacesReady


query#

get query(): KubeApiQueryParams

Returns#

KubeApiQueryParams

Inherited from#

KubeObjectStore.query


selectedItems#

get selectedItems(): Item[]

Returns#

Item[]

Inherited from#

KubeObjectStore.selectedItems

Methods#

[iterator]#

[iterator](): Generator<PersistentVolume, void, undefined>

Returns#

Generator<PersistentVolume, void, undefined>

Inherited from#

KubeObjectStore.[iterator]


bindWatchEventsUpdater#

Protected bindWatchEventsUpdater(delay?): void

Parameters#

Name Type Default value
delay number 1000

Returns#

void

Inherited from#

KubeObjectStore.bindWatchEventsUpdater


create#

create(params, data?): Promise<PersistentVolume>

Parameters#

Name Type
params Object
params.name string
params.namespace? string
data? PartialObjectDeep<PersistentVolume>

Returns#

Promise<PersistentVolume>

Inherited from#

KubeObjectStore.create


createItem#

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

Parameters#

Name Type
params Object
params.name string
params.namespace? string
data? PartialObjectDeep<PersistentVolume>

Returns#

Promise<null | PersistentVolume>

Inherited from#

KubeObjectStore.createItem


defaultSorting#

Protected defaultSorting(item): string

Parameters#

Name Type
item Item

Returns#

string

Inherited from#

KubeObjectStore.defaultSorting


filterItemsOnLoad#

Protected filterItemsOnLoad(items): PersistentVolume[]

Parameters#

Name Type
items PersistentVolume[]

Returns#

PersistentVolume[]

Inherited from#

KubeObjectStore.filterItemsOnLoad


getAllByNs#

getAllByNs(namespace, strict?): PersistentVolume[]

Parameters#

Name Type Default value
namespace string | string[] undefined
strict boolean false

Returns#

PersistentVolume[]

Inherited from#

KubeObjectStore.getAllByNs


getById#

getById(id): undefined | PersistentVolume

Parameters#

Name Type
id string

Returns#

undefined | PersistentVolume

Inherited from#

KubeObjectStore.getById


getByLabel#

getByLabel(labels): PersistentVolume[]

Parameters#

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

Returns#

PersistentVolume[]

Inherited from#

KubeObjectStore.getByLabel


getByName#

getByName(name, namespace?): undefined | PersistentVolume

Parameters#

Name Type
name string
namespace? string

Returns#

undefined | PersistentVolume

Inherited from#

KubeObjectStore.getByName


getByPath#

getByPath(path): undefined | PersistentVolume

Parameters#

Name Type
path string

Returns#

undefined | PersistentVolume

Inherited from#

KubeObjectStore.getByPath


getByStorageClass#

getByStorageClass(storageClass): PersistentVolume[]

Parameters#

Name Type
storageClass StorageClass

Returns#

PersistentVolume[]


getIndexById#

getIndexById(id): number

Parameters#

Name Type
id string

Returns#

number

Inherited from#

KubeObjectStore.getIndexById


getItems#

getItems(): PersistentVolume[]

Returns#

PersistentVolume[]

Inherited from#

KubeObjectStore.getItems


getTotalCount#

getTotalCount(): number

Returns#

number

Inherited from#

KubeObjectStore.getTotalCount


isSelected#

isSelected(item): boolean

Parameters#

Name Type
item PersistentVolume

Returns#

boolean

Inherited from#

KubeObjectStore.isSelected


isSelectedAll#

isSelectedAll(visibleItems?): boolean

Parameters#

Name Type
visibleItems PersistentVolume[]

Returns#

boolean

Inherited from#

KubeObjectStore.isSelectedAll


load#

load(params): Promise<PersistentVolume>

Parameters#

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

Returns#

Promise<PersistentVolume>

Inherited from#

KubeObjectStore.load


loadAll#

loadAll(__namedParameters?): Promise<undefined | PersistentVolume[]>

Parameters#

Name Type
__namedParameters KubeObjectStoreLoadAllParams

Returns#

Promise<undefined | PersistentVolume[]>

Inherited from#

KubeObjectStore.loadAll


loadFromPath#

loadFromPath(resourcePath): Promise<PersistentVolume>

Parameters#

Name Type
resourcePath string

Returns#

Promise<PersistentVolume>

Inherited from#

KubeObjectStore.loadFromPath


loadItem#

Protected loadItem(params): Promise<null | PersistentVolume>

Parameters#

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

Returns#

Promise<null | PersistentVolume>

Inherited from#

KubeObjectStore.loadItem


loadItems#

Protected loadItems(__namedParameters): Promise<PersistentVolume[]>

Parameters#

Name Type
__namedParameters KubeObjectStoreLoadingParams

Returns#

Promise<PersistentVolume[]>

Inherited from#

KubeObjectStore.loadItems


mergeItems#

Protected mergeItems(partialItems, __namedParameters): PersistentVolume[]

Parameters#

Name Type
partialItems PersistentVolume[]
__namedParameters MergeItemsOptions

Returns#

PersistentVolume[]

Inherited from#

KubeObjectStore.mergeItems


patch#

patch(item, patch): Promise<PersistentVolume>

Parameters#

Name Type
item PersistentVolume
patch Patch

Returns#

Promise<PersistentVolume>

Inherited from#

KubeObjectStore.patch


pickOnlySelected#

pickOnlySelected(items): PersistentVolume[]

Parameters#

Name Type
items PersistentVolume[]

Returns#

PersistentVolume[]

Inherited from#

KubeObjectStore.pickOnlySelected


reloadAll#

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

Parameters#

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

Returns#

Promise<undefined | PersistentVolume[]>

Inherited from#

KubeObjectStore.reloadAll


remove#

remove(item): Promise<void>

Parameters#

Name Type
item PersistentVolume

Returns#

Promise<void>

Inherited from#

KubeObjectStore.remove


removeItem#

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

Parameters#

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

Returns#

Promise<void>

Inherited from#

KubeObjectStore.removeItem


removeItems#

removeItems(items): Promise<void>

Parameters#

Name Type
items PersistentVolume[]

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 PersistentVolume

Returns#

void

Inherited from#

KubeObjectStore.select


sortItems#

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

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

PersistentVolume[]

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 PersistentVolume

Returns#

void

Inherited from#

KubeObjectStore.toggleSelection


toggleSelectionAll#

toggleSelectionAll(visibleItems?): void

Parameters#

Name Type
visibleItems PersistentVolume[]

Returns#

void

Inherited from#

KubeObjectStore.toggleSelectionAll


unselect#

unselect(item): void

Parameters#

Name Type
item PersistentVolume

Returns#

void

Inherited from#

KubeObjectStore.unselect


update#

update(item, data): Promise<PersistentVolume>

Parameters#

Name Type
item PersistentVolume
data PartialObjectDeep<PersistentVolume>

Returns#

Promise<PersistentVolume>

Inherited from#

KubeObjectStore.update


updateFromEventsBuffer#

Protected updateFromEventsBuffer(): void

Returns#

void

Inherited from#

KubeObjectStore.updateFromEventsBuffer


updateItem#

Protected updateItem(item, request): Promise<PersistentVolume>

Parameters#

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

Returns#

Promise<PersistentVolume>

Inherited from#

KubeObjectStore.updateItem