Show / Hide Table of Contents

Class V1PersistentVolumeSpec

PersistentVolumeSpec is the specification of a persistent volume.

Inheritance
object
V1PersistentVolumeSpec
Implements
IEquatable<V1PersistentVolumeSpec>
Inherited Members
object.GetType()
object.MemberwiseClone()
object.Equals(object, object)
object.ReferenceEquals(object, object)
Namespace: k8s.Models
Assembly: KubernetesClient.dll
Syntax
public record V1PersistentVolumeSpec : IEquatable<V1PersistentVolumeSpec>

Constructors

View Source

V1PersistentVolumeSpec()

Declaration
public V1PersistentVolumeSpec()
View Source

V1PersistentVolumeSpec(V1PersistentVolumeSpec)

Declaration
protected V1PersistentVolumeSpec(V1PersistentVolumeSpec original)
Parameters
Type Name Description
V1PersistentVolumeSpec original

Properties

View Source

AccessModes

accessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes

Declaration
[JsonPropertyName("accessModes")]
public IList<string> AccessModes { get; set; }
Property Value
Type Description
IList<string>
View Source

AwsElasticBlockStore

awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Declaration
[JsonPropertyName("awsElasticBlockStore")]
public V1AWSElasticBlockStoreVolumeSource AwsElasticBlockStore { get; set; }
Property Value
Type Description
V1AWSElasticBlockStoreVolumeSource
View Source

AzureDisk

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver.

Declaration
[JsonPropertyName("azureDisk")]
public V1AzureDiskVolumeSource AzureDisk { get; set; }
Property Value
Type Description
V1AzureDiskVolumeSource
View Source

AzureFile

azureFile represents an Azure File Service mount on the host and bind mount to the pod. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver.

Declaration
[JsonPropertyName("azureFile")]
public V1AzureFilePersistentVolumeSource AzureFile { get; set; }
Property Value
Type Description
V1AzureFilePersistentVolumeSource
View Source

Capacity

capacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

Declaration
[JsonPropertyName("capacity")]
public IDictionary<string, ResourceQuantity> Capacity { get; set; }
Property Value
Type Description
IDictionary<string, ResourceQuantity>
View Source

Cephfs

cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.

Declaration
[JsonPropertyName("cephfs")]
public V1CephFSPersistentVolumeSource Cephfs { get; set; }
Property Value
Type Description
V1CephFSPersistentVolumeSource
View Source

Cinder

cinder represents a cinder volume attached and mounted on kubelets host machine. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Declaration
[JsonPropertyName("cinder")]
public V1CinderPersistentVolumeSource Cinder { get; set; }
Property Value
Type Description
V1CinderPersistentVolumeSource
View Source

ClaimRef

claimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding

Declaration
[JsonPropertyName("claimRef")]
public V1ObjectReference ClaimRef { get; set; }
Property Value
Type Description
V1ObjectReference
View Source

Csi

csi represents storage that is handled by an external CSI driver.

Declaration
[JsonPropertyName("csi")]
public V1CSIPersistentVolumeSource Csi { get; set; }
Property Value
Type Description
V1CSIPersistentVolumeSource
View Source

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
Type
View Source

Fc

fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

Declaration
[JsonPropertyName("fc")]
public V1FCVolumeSource Fc { get; set; }
Property Value
Type Description
V1FCVolumeSource
View Source

FlexVolume

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.

Declaration
[JsonPropertyName("flexVolume")]
public V1FlexPersistentVolumeSource FlexVolume { get; set; }
Property Value
Type Description
V1FlexPersistentVolumeSource
View Source

Flocker

flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.

Declaration
[JsonPropertyName("flocker")]
public V1FlockerVolumeSource Flocker { get; set; }
Property Value
Type Description
V1FlockerVolumeSource
View Source

GcePersistentDisk

gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Declaration
[JsonPropertyName("gcePersistentDisk")]
public V1GCEPersistentDiskVolumeSource GcePersistentDisk { get; set; }
Property Value
Type Description
V1GCEPersistentDiskVolumeSource
View Source

Glusterfs

glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Declaration
[JsonPropertyName("glusterfs")]
public V1GlusterfsPersistentVolumeSource Glusterfs { get; set; }
Property Value
Type Description
V1GlusterfsPersistentVolumeSource
View Source

HostPath

hostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

Declaration
[JsonPropertyName("hostPath")]
public V1HostPathVolumeSource HostPath { get; set; }
Property Value
Type Description
V1HostPathVolumeSource
View Source

Iscsi

iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.

Declaration
[JsonPropertyName("iscsi")]
public V1ISCSIPersistentVolumeSource Iscsi { get; set; }
Property Value
Type Description
V1ISCSIPersistentVolumeSource
View Source

Local

local represents directly-attached storage with node affinity

Declaration
[JsonPropertyName("local")]
public V1LocalVolumeSource Local { get; set; }
Property Value
Type Description
V1LocalVolumeSource
View Source

MountOptions

mountOptions is the list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options

Declaration
[JsonPropertyName("mountOptions")]
public IList<string> MountOptions { get; set; }
Property Value
Type Description
IList<string>
View Source

Nfs

nfs represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Declaration
[JsonPropertyName("nfs")]
public V1NFSVolumeSource Nfs { get; set; }
Property Value
Type Description
V1NFSVolumeSource
View Source

NodeAffinity

nodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.

Declaration
[JsonPropertyName("nodeAffinity")]
public V1VolumeNodeAffinity NodeAffinity { get; set; }
Property Value
Type Description
V1VolumeNodeAffinity
View Source

PersistentVolumeReclaimPolicy

persistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming

Declaration
[JsonPropertyName("persistentVolumeReclaimPolicy")]
public string PersistentVolumeReclaimPolicy { get; set; }
Property Value
Type Description
string
View Source

PhotonPersistentDisk

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.

Declaration
[JsonPropertyName("photonPersistentDisk")]
public V1PhotonPersistentDiskVolumeSource PhotonPersistentDisk { get; set; }
Property Value
Type Description
V1PhotonPersistentDiskVolumeSource
View Source

PortworxVolume

portworxVolume represents a portworx volume attached and mounted on kubelets host machine. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate is on.

Declaration
[JsonPropertyName("portworxVolume")]
public V1PortworxVolumeSource PortworxVolume { get; set; }
Property Value
Type Description
V1PortworxVolumeSource
View Source

Quobyte

quobyte represents a Quobyte mount on the host that shares a pod's lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.

Declaration
[JsonPropertyName("quobyte")]
public V1QuobyteVolumeSource Quobyte { get; set; }
Property Value
Type Description
V1QuobyteVolumeSource
View Source

Rbd

rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info: https://examples.k8s.io/volumes/rbd/README.md

Declaration
[JsonPropertyName("rbd")]
public V1RBDPersistentVolumeSource Rbd { get; set; }
Property Value
Type Description
V1RBDPersistentVolumeSource
View Source

ScaleIO

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.

Declaration
[JsonPropertyName("scaleIO")]
public V1ScaleIOPersistentVolumeSource ScaleIO { get; set; }
Property Value
Type Description
V1ScaleIOPersistentVolumeSource
View Source

StorageClassName

storageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.

Declaration
[JsonPropertyName("storageClassName")]
public string StorageClassName { get; set; }
Property Value
Type Description
string
View Source

Storageos

storageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. More info: https://examples.k8s.io/volumes/storageos/README.md

Declaration
[JsonPropertyName("storageos")]
public V1StorageOSPersistentVolumeSource Storageos { get; set; }
Property Value
Type Description
V1StorageOSPersistentVolumeSource
View Source

VolumeAttributesClassName

Name of VolumeAttributesClass to which this persistent volume belongs. Empty value is not allowed. When this field is not set, it indicates that this volume does not belong to any VolumeAttributesClass. This field is mutable and can be changed by the CSI driver after a volume has been updated successfully to a new class. For an unbound PersistentVolume, the volumeAttributesClassName will be matched with unbound PersistentVolumeClaims during the binding process.

Declaration
[JsonPropertyName("volumeAttributesClassName")]
public string VolumeAttributesClassName { get; set; }
Property Value
Type Description
string
View Source

VolumeMode

volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec.

Declaration
[JsonPropertyName("volumeMode")]
public string VolumeMode { get; set; }
Property Value
Type Description
string
View Source

VsphereVolume

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver.

Declaration
[JsonPropertyName("vsphereVolume")]
public V1VsphereVirtualDiskVolumeSource VsphereVolume { get; set; }
Property Value
Type Description
V1VsphereVirtualDiskVolumeSource

Methods

View Source

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
object.Equals(object)
View Source

Equals(V1PersistentVolumeSpec?)

Declaration
public virtual bool Equals(V1PersistentVolumeSpec? other)
Parameters
Type Name Description
V1PersistentVolumeSpec other
Returns
Type Description
bool
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()
View Source

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()

Operators

View Source

operator ==(V1PersistentVolumeSpec?, V1PersistentVolumeSpec?)

Declaration
public static bool operator ==(V1PersistentVolumeSpec? left, V1PersistentVolumeSpec? right)
Parameters
Type Name Description
V1PersistentVolumeSpec left
V1PersistentVolumeSpec right
Returns
Type Description
bool
View Source

operator !=(V1PersistentVolumeSpec?, V1PersistentVolumeSpec?)

Declaration
public static bool operator !=(V1PersistentVolumeSpec? left, V1PersistentVolumeSpec? right)
Parameters
Type Name Description
V1PersistentVolumeSpec left
V1PersistentVolumeSpec right
Returns
Type Description
bool

Implements

IEquatable<T>
  • View Source
In this article
Back to top Generated by DocFX