Class StorageClass

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<StorageClassBuilder>, io.fabric8.kubernetes.api.model.HasMetadata, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable

    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
    public class StorageClass
    extends Object
    implements io.fabric8.kubernetes.api.builder.Editable<StorageClassBuilder>, io.fabric8.kubernetes.api.model.HasMetadata
    StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.


    StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

    See Also:
    Serialized Form
    • Field Summary

      • Fields inherited from interface io.fabric8.kubernetes.api.model.HasMetadata

        DNS_LABEL_END, DNS_LABEL_REGEXP, DNS_LABEL_START, FINALIZER_NAME_MATCHER, REQUIRES_NON_NULL_METADATA, REQUIRES_NON_NULL_NAME, REQUIRES_NON_NULL_NAMESPACE
    • Constructor Summary

      Constructors 
      Constructor Description
      StorageClass()
      No args constructor for use in serialization
      StorageClass​(Boolean allowVolumeExpansion, List<io.fabric8.kubernetes.api.model.TopologySelectorTerm> allowedTopologies, String apiVersion, String kind, io.fabric8.kubernetes.api.model.ObjectMeta metadata, List<String> mountOptions, Map<String,​String> parameters, String provisioner, String reclaimPolicy, String volumeBindingMode)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      StorageClassBuilder edit()  
      Map<String,​Object> getAdditionalProperties()  
      List<io.fabric8.kubernetes.api.model.TopologySelectorTerm> getAllowedTopologies()
      allowedTopologies restrict the node topologies where volumes can be dynamically provisioned.
      Boolean getAllowVolumeExpansion()
      allowVolumeExpansion shows whether the storage class allow volume expand.
      String getApiVersion()
      APIVersion defines the versioned schema of this representation of an object.
      String getKind()
      Kind is a string value representing the REST resource this object represents.
      io.fabric8.kubernetes.api.model.ObjectMeta getMetadata()
      StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.
      List<String> getMountOptions()
      mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g.
      Map<String,​String> getParameters()
      parameters holds the parameters for the provisioner that should create volumes of this storage class.
      String getProvisioner()
      provisioner indicates the type of the provisioner.
      String getReclaimPolicy()
      reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class.
      String getVolumeBindingMode()
      volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound.
      void setAdditionalProperties​(Map<String,​Object> additionalProperties)  
      void setAdditionalProperty​(String name, Object value)  
      void setAllowedTopologies​(List<io.fabric8.kubernetes.api.model.TopologySelectorTerm> allowedTopologies)
      allowedTopologies restrict the node topologies where volumes can be dynamically provisioned.
      void setAllowVolumeExpansion​(Boolean allowVolumeExpansion)
      allowVolumeExpansion shows whether the storage class allow volume expand.
      void setApiVersion​(String apiVersion)
      APIVersion defines the versioned schema of this representation of an object.
      void setKind​(String kind)
      Kind is a string value representing the REST resource this object represents.
      void setMetadata​(io.fabric8.kubernetes.api.model.ObjectMeta metadata)
      StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.
      void setMountOptions​(List<String> mountOptions)
      mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g.
      void setParameters​(Map<String,​String> parameters)
      parameters holds the parameters for the provisioner that should create volumes of this storage class.
      void setProvisioner​(String provisioner)
      provisioner indicates the type of the provisioner.
      void setReclaimPolicy​(String reclaimPolicy)
      reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class.
      void setVolumeBindingMode​(String volumeBindingMode)
      volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound.
      StorageClassBuilder toBuilder()  
      • Methods inherited from interface io.fabric8.kubernetes.api.model.HasMetadata

        addFinalizer, addOwnerReference, addOwnerReference, getFinalizers, getFullResourceName, getOwnerReferenceFor, getOwnerReferenceFor, getPlural, getSingular, hasFinalizer, hasOwnerReferenceFor, hasOwnerReferenceFor, initNameAndNamespaceFrom, isFinalizerValid, isMarkedForDeletion, optionalMetadata, removeFinalizer, removeOwnerReference, removeOwnerReference
    • Constructor Detail

      • StorageClass

        public StorageClass()
        No args constructor for use in serialization
      • StorageClass

        public StorageClass​(Boolean allowVolumeExpansion,
                            List<io.fabric8.kubernetes.api.model.TopologySelectorTerm> allowedTopologies,
                            String apiVersion,
                            String kind,
                            io.fabric8.kubernetes.api.model.ObjectMeta metadata,
                            List<String> mountOptions,
                            Map<String,​String> parameters,
                            String provisioner,
                            String reclaimPolicy,
                            String volumeBindingMode)
    • Method Detail

      • getAllowVolumeExpansion

        public Boolean getAllowVolumeExpansion()
        allowVolumeExpansion shows whether the storage class allow volume expand.
      • setAllowVolumeExpansion

        public void setAllowVolumeExpansion​(Boolean allowVolumeExpansion)
        allowVolumeExpansion shows whether the storage class allow volume expand.
      • getAllowedTopologies

        public List<io.fabric8.kubernetes.api.model.TopologySelectorTerm> getAllowedTopologies()
        allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.
      • setAllowedTopologies

        public void setAllowedTopologies​(List<io.fabric8.kubernetes.api.model.TopologySelectorTerm> allowedTopologies)
        allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.
      • getApiVersion

        public String getApiVersion()
        APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
        Specified by:
        getApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata
      • setApiVersion

        public void setApiVersion​(String apiVersion)
        APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
        Specified by:
        setApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata
      • getKind

        public String getKind()
        Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
        Specified by:
        getKind in interface io.fabric8.kubernetes.api.model.HasMetadata
      • setKind

        public void setKind​(String kind)
        Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
      • getMetadata

        public io.fabric8.kubernetes.api.model.ObjectMeta getMetadata()
        StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.


        StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

        Specified by:
        getMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata
      • setMetadata

        public void setMetadata​(io.fabric8.kubernetes.api.model.ObjectMeta metadata)
        StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.


        StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

        Specified by:
        setMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata
      • getMountOptions

        public List<String> getMountOptions()
        mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
      • setMountOptions

        public void setMountOptions​(List<String> mountOptions)
        mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
      • getParameters

        public Map<String,​String> getParameters()
        parameters holds the parameters for the provisioner that should create volumes of this storage class.
      • setParameters

        public void setParameters​(Map<String,​String> parameters)
        parameters holds the parameters for the provisioner that should create volumes of this storage class.
      • getProvisioner

        public String getProvisioner()
        provisioner indicates the type of the provisioner.
      • setProvisioner

        public void setProvisioner​(String provisioner)
        provisioner indicates the type of the provisioner.
      • getReclaimPolicy

        public String getReclaimPolicy()
        reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.
      • setReclaimPolicy

        public void setReclaimPolicy​(String reclaimPolicy)
        reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.
      • getVolumeBindingMode

        public String getVolumeBindingMode()
        volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.
      • setVolumeBindingMode

        public void setVolumeBindingMode​(String volumeBindingMode)
        volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.
      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()
      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                          Object value)
      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)