com.openshift.restclient.model.volume

Interface IPersistentVolume

All Superinterfaces:

Annotatable, IAnnotatable, IApiVersionable, ICapable, IKindable, IResource, ITypeMeta, JSONSerializeable

All Known Implementing Classes:

PersistentVolume

public interface IPersistentVolume
extends IResource

Method Summary

Modifier and Type	Method and Description
Set<String>	getAccessModes()
long	getCapacity()
long	getCapacity(MemoryUnit unit)
long	getCapacity(String unit)
MemoryUnit	getCapacityUnit()
IPersistentVolumeProperties	getPersistentVolumeProperties()
String	getReclaimPolicy()
void	setAccessModes(String... modes) Sets the access modes.
void	setCapacity(long capacity, MemoryUnit unit) Sets the capacity.
void	setPersistentVolumeProperties(IPersistentVolumeProperties properties) Sets the volume type properties.
void	setReclaimPolicy(String policy) Sets the 'spec.persistentVolumeReclaimPolicy' value

Methods inherited from interface com.openshift.restclient.model.IResource

addLabel, getAnnotation, getAnnotations, getCapabilities, getCreationTimeStamp, getLabels, getMetadata, getName, getNamespace, getNamespaceName, getProject, getResourceVersion, isAnnotatedWith, removeAnnotation, setAnnotation

Methods inherited from interface com.openshift.restclient.capability.ICapable

accept, getCapability, supports

Methods inherited from interface com.openshift.restclient.api.models.IApiVersionable

getApiVersion

Methods inherited from interface com.openshift.restclient.api.models.IKindable

getKind

Methods inherited from interface com.openshift.restclient.model.JSONSerializeable

toJson, toJson

Method Detail

getCapacity

long getCapacity(String unit)

Parameters:

unit - the designated unit. One of "Ki", "Mi", "Gi", "Ti", "Pi", "Ei".

Returns:

0, if conversion not possible. Otherwise the capacity in given units.

Throws:

IllegalArgumentException - if not supported unit given.

See Also:

PersistentVolume#convert(String, MemoryUnit)}

getCapacity

long getCapacity(MemoryUnit unit)

Parameters:

unit - the designated unit. One of MemoryUnit's Ki, Mi, Gi, Ti, Pi, Ei.

Returns:

0, if conversion not possible. Otherwise the capacity in given units.

Throws:

IllegalArgumentException - if not supported unit given.

See Also:

PersistentVolume#convert(String, MemoryUnit)}

getCapacity

long getCapacity()

Returns:

the capacity in bytes.

getCapacityUnit

MemoryUnit getCapacityUnit()

Returns:

the unit in which the capacity is represent.

See Also:

MemoryUnit}

setCapacity

void setCapacity(long capacity,
                 MemoryUnit unit)

Sets the capacity. There is no conversion between units.

Parameters:

capacity - the capacity

unit - the unit

getAccessModes

Set<String> getAccessModes()

Returns:

access modes

See Also:

com.openshift.restclient.model.volume.PVCAccessModes},

setAccessModes

void setAccessModes(String... modes)

Sets the access modes. If there are any modes present, they are overridden by the modes parameter.

Parameters:

modes - the access modes

getReclaimPolicy

String getReclaimPolicy()

Returns:

the value of 'spec.persistentVolumeReclaimPolicy'

setReclaimPolicy

void setReclaimPolicy(String policy)

Sets the 'spec.persistentVolumeReclaimPolicy' value

Parameters:

policy - the policy string

getPersistentVolumeProperties

IPersistentVolumeProperties getPersistentVolumeProperties()

Returns:

specific persistent volume type properties

setPersistentVolumeProperties

void setPersistentVolumeProperties(IPersistentVolumeProperties properties)

Sets the volume type properties.

Parameters:

properties - the properties