Skip to content

Class: PersistentVolumeClaimsApi#

Hierarchy#

PersistentVolumeClaimsApi

Index#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

+ new PersistentVolumeClaimsApi(options: IKubeApiOptions‹PersistentVolumeClaim›): PersistentVolumeClaimsApi

Inherited from KubeApi.constructor

Defined in src/renderer/api/kube-api.ts:123

Parameters:

Name Type
options IKubeApiOptions‹PersistentVolumeClaim

Returns: PersistentVolumeClaimsApi

Properties#

apiBase#

apiBase: string

Inherited from KubeApi.apiBase

Defined in src/renderer/api/kube-api.ts:112


apiGroup#

apiGroup: string

Inherited from KubeApi.apiGroup

Defined in src/renderer/api/kube-api.ts:114


apiPrefix#

apiPrefix: string

Inherited from KubeApi.apiPrefix

Defined in src/renderer/api/kube-api.ts:113


apiResource#

apiResource: string

Inherited from KubeApi.apiResource

Defined in src/renderer/api/kube-api.ts:117


apiVersion#

apiVersion: string

Inherited from KubeApi.apiVersion

Defined in src/renderer/api/kube-api.ts:115


Optional apiVersionPreferred#

apiVersionPreferred? : string

Inherited from KubeApi.apiVersionPreferred

Defined in src/renderer/api/kube-api.ts:116


isNamespaced#

isNamespaced: boolean

Inherited from KubeApi.isNamespaced

Defined in src/renderer/api/kube-api.ts:118


kind#

kind: string

Inherited from KubeApi.kind

Defined in src/renderer/api/kube-api.ts:111


objectConstructor#

objectConstructor: IKubeObjectConstructor‹PersistentVolumeClaim

Inherited from KubeApi.objectConstructor

Defined in src/renderer/api/kube-api.ts:120


Protected options#

options: IKubeApiOptions‹PersistentVolumeClaim

Inherited from KubeApi.options

Defined in src/renderer/api/kube-api.ts:125


Protected request#

request: KubeJsonApi

Inherited from KubeApi.request

Defined in src/renderer/api/kube-api.ts:121


Protected resourceVersions#

resourceVersions: Map‹string, string› = new Map()

Inherited from KubeApi.resourceVersions

Defined in src/renderer/api/kube-api.ts:122


Protected watchDisposer#

watchDisposer: function

Inherited from KubeApi.watchDisposer

Defined in src/renderer/api/kube-api.ts:123

Type declaration:#

▸ (): void

Accessors#

apiVersionWithGroup#

get apiVersionWithGroup(): string

Inherited from KubeApi.apiVersionWithGroup

Defined in src/renderer/api/kube-api.ts:153

Returns: string

Methods#

Protected checkPreferredVersion#

checkPreferredVersion(): Promise‹void›

Inherited from KubeApi.checkPreferredVersion

Defined in src/renderer/api/kube-api.ts:215

Returns: Promise‹void›


create#

create(__namedParameters: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim | null›

Inherited from KubeApi.create

Defined in src/renderer/api/kube-api.ts:353

Parameters:

Default value __namedParameters: object= {}

Name Type Default
name string ""
namespace string "default"

Optional data: Partial‹PersistentVolumeClaim

Returns: Promise‹PersistentVolumeClaim | null›


delete#

delete(__namedParameters: object): Promise‹KubeJsonApiData›

Inherited from KubeApi.delete

Defined in src/renderer/api/kube-api.ts:390

Parameters:

__namedParameters: object

Name Type Default
name string ""
namespace string "default"

Returns: Promise‹KubeJsonApiData›


get#

get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹PersistentVolumeClaim | null›

Inherited from KubeApi.get

Defined in src/renderer/api/kube-api.ts:339

Parameters:

Default value __namedParameters: object= {}

Name Type Default
name string ""
namespace string "default"

Optional query: IKubeApiQueryParams

Returns: Promise‹PersistentVolumeClaim | null›


getMetrics#

getMetrics(pvcName: string, namespace: string): Promise‹IPvcMetrics›

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:8

Parameters:

Name Type
pvcName string
namespace string

Returns: Promise‹IPvcMetrics›


getResourceVersion#

getResourceVersion(namespace: string): string

Inherited from KubeApi.getResourceVersion

Defined in src/renderer/api/kube-api.ts:248

Parameters:

Name Type Default
namespace string ""

Returns: string


getUrl#

getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

Inherited from KubeApi.getUrl

Defined in src/renderer/api/kube-api.ts:256

Parameters:

Default value __namedParameters: object= {}

Name Type Default
name string ""
namespace string ""

Optional query: Partial‹IKubeApiQueryParams›

Returns: string


getWatchUrl#

getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

Inherited from KubeApi.getWatchUrl

Defined in src/renderer/api/kube-api.ts:397

Parameters:

Name Type Default
namespace string ""
query IKubeApiQueryParams {}

Returns: string


list#

list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹PersistentVolumeClaim[] | null›

Inherited from KubeApi.list

Defined in src/renderer/api/kube-api.ts:321

Parameters:

Default value __namedParameters: object= {}

Name Type Default
namespace string ""
reqInit RequestInit -

Optional query: IKubeApiQueryParams

Returns: Promise‹PersistentVolumeClaim[] | null›


Protected modifyWatchEvent#

modifyWatchEvent(event: IKubeWatchEvent): void

Inherited from KubeApi.modifyWatchEvent

Defined in src/renderer/api/kube-api.ts:462

Parameters:

Name Type
event IKubeWatchEvent

Returns: void


Protected normalizeQuery#

normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

Inherited from KubeApi.normalizeQuery

Defined in src/renderer/api/kube-api.ts:268

Parameters:

Name Type Default
query Partial‹IKubeApiQueryParams› {}

Returns: object


Protected parseResponse#

parseResponse(data: unknown, namespace?: string): PersistentVolumeClaim | PersistentVolumeClaim[] | null

Inherited from KubeApi.parseResponse

Defined in src/renderer/api/kube-api.ts:280

Parameters:

Name Type
data unknown
namespace? string

Returns: PersistentVolumeClaim | PersistentVolumeClaim[] | null


refreshResourceVersion#

refreshResourceVersion(params?: KubeApiListOptions): Promise‹T[]›

Inherited from KubeApi.refreshResourceVersion

Defined in src/renderer/api/kube-api.ts:252

Parameters:

Name Type
params? KubeApiListOptions

Returns: Promise‹T[]›


setResourceVersion#

setResourceVersion(namespace: string, newVersion: string): void

Inherited from KubeApi.setResourceVersion

Defined in src/renderer/api/kube-api.ts:244

Parameters:

Name Type Default
namespace string ""
newVersion string -

Returns: void


update#

update(__namedParameters: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim | null›

Inherited from KubeApi.update

Defined in src/renderer/api/kube-api.ts:376

Parameters:

Default value __namedParameters: object= {}

Name Type Default
name string ""
namespace string "default"

Optional data: Partial‹PersistentVolumeClaim

Returns: Promise‹PersistentVolumeClaim | null›


watch#

watch(opts: KubeApiWatchOptions): function

Inherited from KubeApi.watch

Defined in src/renderer/api/kube-api.ts:405

Parameters:

Name Type Default
opts KubeApiWatchOptions { namespace: "" }

Returns: function

▸ (): void