@hashgraph/solo/src/core/kube/resources/pvc/pvcs.ts

An opinionated CLI tool to deploy and manage private Hedera Networks.

/**
 * SPDX-License-Identifier: Apache-2.0
 */
import {type NamespaceName} from '../namespace/namespace_name.js';
import {type Pvc} from './pvc.js';
import {type PvcRef} from './pvc_ref.js';

export interface Pvcs {
  /**
   * Delete a persistent volume claim
   * @param pvcRef - the persistent volume claim reference
   * @returns true if the persistent volume claim was deleted
   * @throws {SoloError} if the persistent volume claim could not be deleted
   */
  delete(pvcRef: PvcRef): Promise<boolean>;

  /**
   * Get a list of persistent volume claim names for the given namespace
   * @param namespace - the namespace of the persistent volume claims to return
   * @param [labels] - labels
   * @returns list of persistent volume claim names
   * @throws {SoloError} if the persistent volume claims could not be listed
   */
  list(namespace: NamespaceName, labels: string[]): Promise<string[]>;

  /**
   * Create a persistent volume claim
   * @param pvcRef - the persistent volume claim reference
   * @param labels - the labels to apply to the persistent volume claim
   * @param accessModes - the access modes for the persistent volume claim
   * @returns the persistent volume claim
   * @throws {SoloError} if the persistent volume claim could not be created
   */
  create(pvcRef: PvcRef, labels: Record<string, string>, accessModes: string[]): Promise<Pvc>;
}