com.openshift.internal.restclient.model.volume

Class PersistentVolume

java.lang.Object

com.openshift.internal.restclient.model.KubernetesResource

com.openshift.internal.restclient.model.volume.PersistentVolume

All Implemented Interfaces:

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

public class PersistentVolume
extends KubernetesResource
implements IPersistentVolume

Field Summary

Fields inherited from interface com.openshift.internal.restclient.model.properties.ResourcePropertyKeys

ANNOTATIONS, APIVERSION, CREATION_TIMESTAMP, FROM, GROUP, KIND, LABELS, METADATA, METADATA_NAME, METADATA_NAMESPACE, METADATA_RESOURCE_VERSION, METADATA_UID, NAME, NAMESPACE, OBJECTS, PORTS, PROTOCOL, RESOURCE_VERSION, TYPE, VALUE, VERBS, VERSION

Constructor Summary

Constructors

Constructor and Description
PersistentVolume(org.jboss.dmr.ModelNode node, IClient client, Map<String,String[]> propertyKeys)

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	getPVType()
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 class com.openshift.internal.restclient.model.KubernetesResource

accept, addLabel, asBoolean, asBoolean, asInt, asInt, asMap, asSet, asString, asString, equals, get, get, getAnnotation, getAnnotations, getApiVersion, getCapabilities, getCapability, getClient, getCreationTimeStamp, getEnvMap, getKind, getLabels, getMetadata, getModifiableCapabilities, getName, getNamespace, getNamespaceName, getNode, getPath, getProject, getPropertyKeys, getResourceVersion, has, hashCode, isAnnotatedWith, refresh, removeAnnotation, set, set, set, set, set, set, set, set, set, setAnnotation, setEnvMap, setName, setNamespace, setNode, supports, toJson, toJson, toPrettyString, toString

Methods inherited from class java.lang.Object

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

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

Constructor Detail

PersistentVolume

public PersistentVolume(org.jboss.dmr.ModelNode node,
                        IClient client,
                        Map<String,String[]> propertyKeys)

Method Detail

getCapacity

public long getCapacity(String unit)

Specified by:

getCapacity in interface IPersistentVolume

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

public long getCapacity(MemoryUnit unit)

Specified by:

getCapacity in interface IPersistentVolume

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

public long getCapacity()

Specified by:

getCapacity in interface IPersistentVolume

Returns:

the capacity in bytes.

setCapacity

public void setCapacity(long capacity,
                        MemoryUnit unit)

Sets the capacity. There is no conversion between units.

Specified by:

setCapacity in interface IPersistentVolume

Parameters:

capacity - the capacity

unit - the unit

getCapacityUnit

public MemoryUnit getCapacityUnit()

Specified by:

getCapacityUnit in interface IPersistentVolume

Returns:

the unit in which the capacity is represent.

See Also:

MemoryUnit}

getAccessModes

public Set<String> getAccessModes()

Specified by:

getAccessModes in interface IPersistentVolume

Returns:

access modes

See Also:

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

setAccessModes

public void setAccessModes(String... modes)

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

Specified by:

setAccessModes in interface IPersistentVolume

Parameters:

modes - the access modes

getReclaimPolicy

public String getReclaimPolicy()

Specified by:

getReclaimPolicy in interface IPersistentVolume

Returns:

the value of 'spec.persistentVolumeReclaimPolicy'

setReclaimPolicy

public void setReclaimPolicy(String policy)

Sets the 'spec.persistentVolumeReclaimPolicy' value

Specified by:

setReclaimPolicy in interface IPersistentVolume

Parameters:

policy - the policy string

getPersistentVolumeProperties

public IPersistentVolumeProperties getPersistentVolumeProperties()

Specified by:

getPersistentVolumeProperties in interface IPersistentVolume

Returns:

specific persistent volume type

setPersistentVolumeProperties

public void setPersistentVolumeProperties(IPersistentVolumeProperties properties)

Sets the volume type properties.

Specified by:

setPersistentVolumeProperties in interface IPersistentVolume

Parameters:

properties - the properties

getPVType

public String getPVType()

Returns:

a string value of the type. One of VolumeType.