Class K8ClientPvcs

Implements

Pvcs

Index

Constructors

Methods

create delete list

Constructors

constructor

new K8ClientPvcs(kubeClient: CoreV1Api): K8ClientPvcs
Parameters
- kubeClient: CoreV1Api
Returns K8ClientPvcs
- Defined in src/integration/kube/k8-client/resources/pvc/k8-client-pvcs.ts:24

Methods

create

create(
    pvcReference: PvcReference,
    labels: Record<string, string>,
    accessModes: string[],
): Promise<Pvc>
Create a persistent volume claim
Parameters
- pvcReference: PvcReference
- labels: Record<string, string>
  the labels to apply to the persistent volume claim
- accessModes: string[]
  the access modes for the persistent volume claim
Returns Promise<Pvc>
the persistent volume claim

Throws
if the persistent volume claim could not be created
Implementation of Pvcs.create
- Defined in src/integration/kube/k8-client/resources/pvc/k8-client-pvcs.ts:80

delete

delete(pvcReference: PvcReference): Promise<boolean>
Delete a persistent volume claim
Parameters
- pvcReference: PvcReference
Returns Promise<boolean>
true if the persistent volume claim was deleted

Throws
if the persistent volume claim could not be deleted
Implementation of Pvcs.delete
- Defined in src/integration/kube/k8-client/resources/pvc/k8-client-pvcs.ts:26

list

list(namespace: NamespaceName, labels: string[]): Promise<string[]>
Get a list of persistent volume claim names for the given namespace
Parameters
- namespace: NamespaceName
  the namespace of the persistent volume claims to return
- labels: string[]
  labels
Returns Promise<string[]>
list of persistent volume claim names

Throws
if the persistent volume claims could not be listed
Implementation of Pvcs.list
- Defined in src/integration/kube/k8-client/resources/pvc/k8-client-pvcs.ts:48