io.k8s.api.core.v1.PersistentVolumeClaimSpec Maven / Gradle / Ivy

Go to download
package io.k8s.api.core.v1;

import io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector;
import java.lang.String;
import java.util.List;

/**
 * PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
 */
public class PersistentVolumeClaimSpec {
  public List accessModes;

  public TypedLocalObjectReference dataSource;

  public TypedObjectReference dataSourceRef;

  public VolumeResourceRequirements resources;

  public LabelSelector selector;

  public String storageClassName;

  public String volumeAttributesClassName;

  public String volumeMode;

  public String volumeName;

  /**
   * accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
   */
  public PersistentVolumeClaimSpec accessModes(List accessModes) {
    this.accessModes = accessModes;
    return this;
  }

  public PersistentVolumeClaimSpec dataSource(TypedLocalObjectReference dataSource) {
    this.dataSource = dataSource;
    return this;
  }

  public PersistentVolumeClaimSpec dataSourceRef(TypedObjectReference dataSourceRef) {
    this.dataSourceRef = dataSourceRef;
    return this;
  }

  public PersistentVolumeClaimSpec resources(VolumeResourceRequirements resources) {
    this.resources = resources;
    return this;
  }

  public PersistentVolumeClaimSpec selector(LabelSelector selector) {
    this.selector = selector;
    return this;
  }

  /**
   * storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
   */
  public PersistentVolumeClaimSpec storageClassName(String storageClassName) {
    this.storageClassName = storageClassName;
    return this;
  }

  /**
   * volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.
   */
  public PersistentVolumeClaimSpec volumeAttributesClassName(String volumeAttributesClassName) {
    this.volumeAttributesClassName = volumeAttributesClassName;
    return this;
  }

  /**
   * volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
   */
  public PersistentVolumeClaimSpec volumeMode(String volumeMode) {
    this.volumeMode = volumeMode;
    return this;
  }

  /**
   * volumeName is the binding reference to the PersistentVolume backing this claim.
   */
  public PersistentVolumeClaimSpec volumeName(String volumeName) {
    this.volumeName = volumeName;
    return this;
  }

  public static PersistentVolumeClaimSpec persistentVolumeClaimSpec() {
    return new PersistentVolumeClaimSpec();
  }
}