io.kubernetes.client.models

Class V1PersistentVolumeSpec

java.lang.Object

io.kubernetes.client.models.V1PersistentVolumeSpec

public class V1PersistentVolumeSpec
extends Object

PersistentVolumeSpec is the specification of a persistent volume.

Constructor Summary

Constructors

Constructor and Description
V1PersistentVolumeSpec()

Method Summary

Modifier and Type	Method and Description
V1PersistentVolumeSpec	accessModes(List<String> accessModes)
V1PersistentVolumeSpec	addAccessModesItem(String accessModesItem)
V1PersistentVolumeSpec	addMountOptionsItem(String mountOptionsItem)
V1PersistentVolumeSpec	awsElasticBlockStore(V1AWSElasticBlockStoreVolumeSource awsElasticBlockStore)
V1PersistentVolumeSpec	azureDisk(V1AzureDiskVolumeSource azureDisk)
V1PersistentVolumeSpec	azureFile(V1AzureFilePersistentVolumeSource azureFile)
V1PersistentVolumeSpec	capacity(Map<String,Quantity> capacity)
V1PersistentVolumeSpec	cephfs(V1CephFSPersistentVolumeSource cephfs)
V1PersistentVolumeSpec	cinder(V1CinderPersistentVolumeSource cinder)
V1PersistentVolumeSpec	claimRef(V1ObjectReference claimRef)
V1PersistentVolumeSpec	csi(V1CSIPersistentVolumeSource csi)
boolean	equals(Object o)
V1PersistentVolumeSpec	fc(V1FCVolumeSource fc)
V1PersistentVolumeSpec	flexVolume(V1FlexPersistentVolumeSource flexVolume)
V1PersistentVolumeSpec	flocker(V1FlockerVolumeSource flocker)
V1PersistentVolumeSpec	gcePersistentDisk(V1GCEPersistentDiskVolumeSource gcePersistentDisk)
List<String>	getAccessModes() AccessModes contains all ways the volume can be mounted.
V1AWSElasticBlockStoreVolumeSource	getAwsElasticBlockStore() AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod.
V1AzureDiskVolumeSource	getAzureDisk() AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
V1AzureFilePersistentVolumeSource	getAzureFile() AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
Map<String,Quantity>	getCapacity() A description of the persistent volume's resources and capacity.
V1CephFSPersistentVolumeSource	getCephfs() CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
V1CinderPersistentVolumeSource	getCinder() Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
V1ObjectReference	getClaimRef() ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.
V1CSIPersistentVolumeSource	getCsi() CSI represents storage that handled by an external CSI driver (Beta feature).
V1FCVolumeSource	getFc() FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
V1FlexPersistentVolumeSource	getFlexVolume() FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
V1FlockerVolumeSource	getFlocker() Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage.
V1GCEPersistentDiskVolumeSource	getGcePersistentDisk() GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod.
V1GlusterfsPersistentVolumeSource	getGlusterfs() Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod.
V1HostPathVolumeSource	getHostPath() HostPath represents a directory on the host.
V1ISCSIPersistentVolumeSource	getIscsi() ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod.
V1LocalVolumeSource	getLocal() Local represents directly-attached storage with node affinity
List<String>	getMountOptions() A list of mount options, e.g.
V1NFSVolumeSource	getNfs() NFS represents an NFS mount on the host.
V1VolumeNodeAffinity	getNodeAffinity() NodeAffinity defines constraints that limit what nodes this volume can be accessed from.
String	getPersistentVolumeReclaimPolicy() What happens to a persistent volume when released from its claim.
V1PhotonPersistentDiskVolumeSource	getPhotonPersistentDisk() PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
V1PortworxVolumeSource	getPortworxVolume() PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
V1QuobyteVolumeSource	getQuobyte() Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
V1RBDPersistentVolumeSource	getRbd() RBD represents a Rados Block Device mount on the host that shares a pod's lifetime.
V1ScaleIOPersistentVolumeSource	getScaleIO() ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
String	getStorageClassName() Name of StorageClass to which this persistent volume belongs.
V1StorageOSPersistentVolumeSource	getStorageos() StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://releases.k8s.io/HEAD/examples/volumes/storageos/README.md
String	getVolumeMode() volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state.
V1VsphereVirtualDiskVolumeSource	getVsphereVolume() VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
V1PersistentVolumeSpec	glusterfs(V1GlusterfsPersistentVolumeSource glusterfs)
int	hashCode()
V1PersistentVolumeSpec	hostPath(V1HostPathVolumeSource hostPath)
V1PersistentVolumeSpec	iscsi(V1ISCSIPersistentVolumeSource iscsi)
V1PersistentVolumeSpec	local(V1LocalVolumeSource local)
V1PersistentVolumeSpec	mountOptions(List<String> mountOptions)
V1PersistentVolumeSpec	nfs(V1NFSVolumeSource nfs)
V1PersistentVolumeSpec	nodeAffinity(V1VolumeNodeAffinity nodeAffinity)
V1PersistentVolumeSpec	persistentVolumeReclaimPolicy(String persistentVolumeReclaimPolicy)
V1PersistentVolumeSpec	photonPersistentDisk(V1PhotonPersistentDiskVolumeSource photonPersistentDisk)
V1PersistentVolumeSpec	portworxVolume(V1PortworxVolumeSource portworxVolume)
V1PersistentVolumeSpec	putCapacityItem(String key, Quantity capacityItem)
V1PersistentVolumeSpec	quobyte(V1QuobyteVolumeSource quobyte)
V1PersistentVolumeSpec	rbd(V1RBDPersistentVolumeSource rbd)
V1PersistentVolumeSpec	scaleIO(V1ScaleIOPersistentVolumeSource scaleIO)
void	setAccessModes(List<String> accessModes)
void	setAwsElasticBlockStore(V1AWSElasticBlockStoreVolumeSource awsElasticBlockStore)
void	setAzureDisk(V1AzureDiskVolumeSource azureDisk)
void	setAzureFile(V1AzureFilePersistentVolumeSource azureFile)
void	setCapacity(Map<String,Quantity> capacity)
void	setCephfs(V1CephFSPersistentVolumeSource cephfs)
void	setCinder(V1CinderPersistentVolumeSource cinder)
void	setClaimRef(V1ObjectReference claimRef)
void	setCsi(V1CSIPersistentVolumeSource csi)
void	setFc(V1FCVolumeSource fc)
void	setFlexVolume(V1FlexPersistentVolumeSource flexVolume)
void	setFlocker(V1FlockerVolumeSource flocker)
void	setGcePersistentDisk(V1GCEPersistentDiskVolumeSource gcePersistentDisk)
void	setGlusterfs(V1GlusterfsPersistentVolumeSource glusterfs)
void	setHostPath(V1HostPathVolumeSource hostPath)
void	setIscsi(V1ISCSIPersistentVolumeSource iscsi)
void	setLocal(V1LocalVolumeSource local)
void	setMountOptions(List<String> mountOptions)
void	setNfs(V1NFSVolumeSource nfs)
void	setNodeAffinity(V1VolumeNodeAffinity nodeAffinity)
void	setPersistentVolumeReclaimPolicy(String persistentVolumeReclaimPolicy)
void	setPhotonPersistentDisk(V1PhotonPersistentDiskVolumeSource photonPersistentDisk)
void	setPortworxVolume(V1PortworxVolumeSource portworxVolume)
void	setQuobyte(V1QuobyteVolumeSource quobyte)
void	setRbd(V1RBDPersistentVolumeSource rbd)
void	setScaleIO(V1ScaleIOPersistentVolumeSource scaleIO)
void	setStorageClassName(String storageClassName)
void	setStorageos(V1StorageOSPersistentVolumeSource storageos)
void	setVolumeMode(String volumeMode)
void	setVsphereVolume(V1VsphereVirtualDiskVolumeSource vsphereVolume)
V1PersistentVolumeSpec	storageClassName(String storageClassName)
V1PersistentVolumeSpec	storageos(V1StorageOSPersistentVolumeSource storageos)
String	toString()
V1PersistentVolumeSpec	volumeMode(String volumeMode)
V1PersistentVolumeSpec	vsphereVolume(V1VsphereVirtualDiskVolumeSource vsphereVolume)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

V1PersistentVolumeSpec

public V1PersistentVolumeSpec()

Method Detail

accessModes

public V1PersistentVolumeSpec accessModes(List<String> accessModes)

addAccessModesItem

public V1PersistentVolumeSpec addAccessModesItem(String accessModesItem)

getAccessModes

public List<String> getAccessModes()

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

Returns:

accessModes

setAccessModes

public void setAccessModes(List<String> accessModes)

awsElasticBlockStore

public V1PersistentVolumeSpec awsElasticBlockStore(V1AWSElasticBlockStoreVolumeSource awsElasticBlockStore)

getAwsElasticBlockStore

public V1AWSElasticBlockStoreVolumeSource getAwsElasticBlockStore()

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Returns:

awsElasticBlockStore

setAwsElasticBlockStore

public void setAwsElasticBlockStore(V1AWSElasticBlockStoreVolumeSource awsElasticBlockStore)

azureDisk

public V1PersistentVolumeSpec azureDisk(V1AzureDiskVolumeSource azureDisk)

getAzureDisk

public V1AzureDiskVolumeSource getAzureDisk()

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Returns:

azureDisk

setAzureDisk

public void setAzureDisk(V1AzureDiskVolumeSource azureDisk)

azureFile

public V1PersistentVolumeSpec azureFile(V1AzureFilePersistentVolumeSource azureFile)

getAzureFile

public V1AzureFilePersistentVolumeSource getAzureFile()

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

Returns:

azureFile

setAzureFile

public void setAzureFile(V1AzureFilePersistentVolumeSource azureFile)

capacity

public V1PersistentVolumeSpec capacity(Map<String,Quantity> capacity)

putCapacityItem

public V1PersistentVolumeSpec putCapacityItem(String key,
                                              Quantity capacityItem)

getCapacity

public Map<String,Quantity> getCapacity()

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

Returns:

capacity

setCapacity

public void setCapacity(Map<String,Quantity> capacity)

cephfs

public V1PersistentVolumeSpec cephfs(V1CephFSPersistentVolumeSource cephfs)

getCephfs

public V1CephFSPersistentVolumeSource getCephfs()

CephFS represents a Ceph FS mount on the host that shares a pod's lifetime

Returns:

cephfs

setCephfs

public void setCephfs(V1CephFSPersistentVolumeSource cephfs)

cinder

public V1PersistentVolumeSpec cinder(V1CinderPersistentVolumeSource cinder)

getCinder

public V1CinderPersistentVolumeSource getCinder()

Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

Returns:

cinder

setCinder

public void setCinder(V1CinderPersistentVolumeSource cinder)

claimRef

public V1PersistentVolumeSpec claimRef(V1ObjectReference claimRef)

getClaimRef

public V1ObjectReference getClaimRef()

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

Returns:

claimRef

setClaimRef

public void setClaimRef(V1ObjectReference claimRef)

csi

public V1PersistentVolumeSpec csi(V1CSIPersistentVolumeSource csi)

getCsi

public V1CSIPersistentVolumeSource getCsi()

CSI represents storage that handled by an external CSI driver (Beta feature).

Returns:

csi

setCsi

public void setCsi(V1CSIPersistentVolumeSource csi)

fc

public V1PersistentVolumeSpec fc(V1FCVolumeSource fc)

getFc

public V1FCVolumeSource getFc()

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

Returns:

fc

setFc

public void setFc(V1FCVolumeSource fc)

flexVolume

public V1PersistentVolumeSpec flexVolume(V1FlexPersistentVolumeSource flexVolume)

getFlexVolume

public V1FlexPersistentVolumeSource getFlexVolume()

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Returns:

flexVolume

setFlexVolume

public void setFlexVolume(V1FlexPersistentVolumeSource flexVolume)

flocker

public V1PersistentVolumeSpec flocker(V1FlockerVolumeSource flocker)

getFlocker

public V1FlockerVolumeSource getFlocker()

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

Returns:

flocker

setFlocker

public void setFlocker(V1FlockerVolumeSource flocker)

gcePersistentDisk

public V1PersistentVolumeSpec gcePersistentDisk(V1GCEPersistentDiskVolumeSource gcePersistentDisk)

getGcePersistentDisk

public V1GCEPersistentDiskVolumeSource getGcePersistentDisk()

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. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Returns:

gcePersistentDisk

setGcePersistentDisk

public void setGcePersistentDisk(V1GCEPersistentDiskVolumeSource gcePersistentDisk)

glusterfs

public V1PersistentVolumeSpec glusterfs(V1GlusterfsPersistentVolumeSource glusterfs)

getGlusterfs

public V1GlusterfsPersistentVolumeSource getGlusterfs()

Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md

Returns:

glusterfs

setGlusterfs

public void setGlusterfs(V1GlusterfsPersistentVolumeSource glusterfs)

hostPath

public V1PersistentVolumeSpec hostPath(V1HostPathVolumeSource hostPath)

getHostPath

public V1HostPathVolumeSource getHostPath()

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

Returns:

hostPath

setHostPath

public void setHostPath(V1HostPathVolumeSource hostPath)

iscsi

public V1PersistentVolumeSpec iscsi(V1ISCSIPersistentVolumeSource iscsi)

getIscsi

public V1ISCSIPersistentVolumeSource getIscsi()

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.

Returns:

iscsi

setIscsi

public void setIscsi(V1ISCSIPersistentVolumeSource iscsi)

local

public V1PersistentVolumeSpec local(V1LocalVolumeSource local)

getLocal

public V1LocalVolumeSource getLocal()

Local represents directly-attached storage with node affinity

Returns:

local

setLocal

public void setLocal(V1LocalVolumeSource local)

mountOptions

public V1PersistentVolumeSpec mountOptions(List<String> mountOptions)

addMountOptionsItem

public V1PersistentVolumeSpec addMountOptionsItem(String mountOptionsItem)

getMountOptions

public List<String> getMountOptions()

A 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

Returns:

mountOptions

setMountOptions

public void setMountOptions(List<String> mountOptions)

nfs

public V1PersistentVolumeSpec nfs(V1NFSVolumeSource nfs)

getNfs

public V1NFSVolumeSource getNfs()

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

Returns:

nfs

setNfs

public void setNfs(V1NFSVolumeSource nfs)

nodeAffinity

public V1PersistentVolumeSpec nodeAffinity(V1VolumeNodeAffinity nodeAffinity)

getNodeAffinity

public V1VolumeNodeAffinity getNodeAffinity()

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

Returns:

nodeAffinity

setNodeAffinity

public void setNodeAffinity(V1VolumeNodeAffinity nodeAffinity)

persistentVolumeReclaimPolicy

public V1PersistentVolumeSpec persistentVolumeReclaimPolicy(String persistentVolumeReclaimPolicy)

getPersistentVolumeReclaimPolicy

public String getPersistentVolumeReclaimPolicy()

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

Returns:

persistentVolumeReclaimPolicy

setPersistentVolumeReclaimPolicy

public void setPersistentVolumeReclaimPolicy(String persistentVolumeReclaimPolicy)

photonPersistentDisk

public V1PersistentVolumeSpec photonPersistentDisk(V1PhotonPersistentDiskVolumeSource photonPersistentDisk)

getPhotonPersistentDisk

public V1PhotonPersistentDiskVolumeSource getPhotonPersistentDisk()

PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Returns:

photonPersistentDisk

setPhotonPersistentDisk

public void setPhotonPersistentDisk(V1PhotonPersistentDiskVolumeSource photonPersistentDisk)

portworxVolume

public V1PersistentVolumeSpec portworxVolume(V1PortworxVolumeSource portworxVolume)

getPortworxVolume

public V1PortworxVolumeSource getPortworxVolume()

PortworxVolume represents a portworx volume attached and mounted on kubelets host machine

Returns:

portworxVolume

setPortworxVolume

public void setPortworxVolume(V1PortworxVolumeSource portworxVolume)

quobyte

public V1PersistentVolumeSpec quobyte(V1QuobyteVolumeSource quobyte)

getQuobyte

public V1QuobyteVolumeSource getQuobyte()

Quobyte represents a Quobyte mount on the host that shares a pod's lifetime

Returns:

quobyte

setQuobyte

public void setQuobyte(V1QuobyteVolumeSource quobyte)

rbd

public V1PersistentVolumeSpec rbd(V1RBDPersistentVolumeSource rbd)

getRbd

public V1RBDPersistentVolumeSource getRbd()

RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md

Returns:

rbd

setRbd

public void setRbd(V1RBDPersistentVolumeSource rbd)

scaleIO

public V1PersistentVolumeSpec scaleIO(V1ScaleIOPersistentVolumeSource scaleIO)

getScaleIO

public V1ScaleIOPersistentVolumeSource getScaleIO()

ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Returns:

scaleIO

setScaleIO

public void setScaleIO(V1ScaleIOPersistentVolumeSource scaleIO)

storageClassName

public V1PersistentVolumeSpec storageClassName(String storageClassName)

getStorageClassName

public String getStorageClassName()

Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.

Returns:

storageClassName

setStorageClassName

public void setStorageClassName(String storageClassName)

storageos

public V1PersistentVolumeSpec storageos(V1StorageOSPersistentVolumeSource storageos)

getStorageos

public V1StorageOSPersistentVolumeSource getStorageos()

StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://releases.k8s.io/HEAD/examples/volumes/storageos/README.md

Returns:

storageos

setStorageos

public void setStorageos(V1StorageOSPersistentVolumeSource storageos)

volumeMode

public V1PersistentVolumeSpec volumeMode(String volumeMode)

getVolumeMode

public String getVolumeMode()

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. This is a beta feature.

Returns:

volumeMode

setVolumeMode

public void setVolumeMode(String volumeMode)

vsphereVolume

public V1PersistentVolumeSpec vsphereVolume(V1VsphereVirtualDiskVolumeSource vsphereVolume)

getVsphereVolume

public V1VsphereVirtualDiskVolumeSource getVsphereVolume()

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Returns:

vsphereVolume

setVsphereVolume

public void setVsphereVolume(V1VsphereVirtualDiskVolumeSource vsphereVolume)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object