zio-k8s-client/com.coralogix.zio.k8s.model.storage.v1/StorageClass

StorageClass

case class StorageClass(allowVolumeExpansion: Optional[Boolean], allowedTopologies: Optional[Vector[TopologySelectorTerm]], metadata: Optional[ObjectMeta], mountOptions: Optional[Vector[String]], parameters: Optional[Map[String, String]], provisioner: String, reclaimPolicy: Optional[String], volumeBindingMode: Optional[String])

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.

Value parameters:
allowVolumeExpansion

AllowVolumeExpansion shows whether the storage class allow volume expand

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.

mountOptions

Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.

parameters

Parameters holds the parameters for the provisioner that should create volumes of this storage class.

provisioner

Provisioner indicates the type of the provisioner.

reclaimPolicy

Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.

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.

Companion:
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def getAllowVolumeExpansion: IO[K8sFailure, Boolean]

AllowVolumeExpansion shows whether the storage class allow volume expand

AllowVolumeExpansion shows whether the storage class allow volume expand

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getAllowedTopologies: IO[K8sFailure, Vector[TopologySelectorTerm]]

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.

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.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getMetadata: IO[K8sFailure, ObjectMeta]

Gets metadata.

Gets metadata.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getMountOptions: IO[K8sFailure, Vector[String]]

Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.

Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getParameters: IO[K8sFailure, Map[String, String]]

Parameters holds the parameters for the provisioner that should create volumes of this storage class.

Parameters holds the parameters for the provisioner that should create volumes of this storage class.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getProvisioner: IO[K8sFailure, String]

Provisioner indicates the type of the provisioner.

Provisioner indicates the type of the provisioner.

This effect always succeeds, it is safe to use the field provisioner directly.

def getReclaimPolicy: IO[K8sFailure, String]

Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.

Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getVolumeBindingMode: IO[K8sFailure, String]

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.

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.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

Inherited methods

def attachOwner(ownerName: String, ownerUid: String, ownerType: K8sResourceType, kind: String): StorageClass
Implicitly added by Ops

Attach another resource as the owner of this one

Attach another resource as the owner of this one

Value parameters:
kind

Owner's resource kind

ownerName

Owner's name

ownerType

Owner's resource type metadata

ownerUid

Owner's UID

Returns:

Object with the attached owner described in its metadata

Inherited from:
K8sObjectOps
def generation: Long
Implicitly added by Ops

Gets the geneation of the object or 0 if it is new

Gets the geneation of the object or 0 if it is new

Inherited from:
K8sObjectOps
def getMetadata: IO[K8sFailure, ObjectMeta]
Implicitly added by Ops

Gets the metadata of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Gets the metadata of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Inherited from:
K8sObjectOps
def getName: IO[K8sFailure, String]
Implicitly added by Ops

Gets the name of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Gets the name of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Inherited from:
K8sObjectOps
def getUid: IO[K8sFailure, String]
Implicitly added by Ops

Gets the UID of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Gets the UID of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Inherited from:
K8sObjectOps
def isOwnedBy[OwnerT : ResourceMetadata](owner: OwnerT): Boolean
Implicitly added by Ops

Verifies ownership between the resources

Verifies ownership between the resources

Type parameters:
OwnerT

Type of the owner resource

Value parameters:
owner

Possible owner of this resource

Returns:

True if owner owns this resource

Inherited from:
K8sObjectOps
def mapMetadata(f: ObjectMeta => ObjectMeta): StorageClass
Implicitly added by Ops

Creates a new object with its metadata modified by the given function f

Creates a new object with its metadata modified by the given function f

Value parameters:
f

Function to modify the object's metadata with

Returns:

Object with modified metadata

Inherited from:
K8sObjectOps
def metadata: Optional[ObjectMeta]
Implicitly added by Ops

Gets the metadata of the object

Gets the metadata of the object

Inherited from:
K8sObjectOps
def productIterator: Iterator[Any]
Inherited from:
Product
def tryAttachOwner[OwnerT : ResourceMetadata](owner: OwnerT): IO[K8sFailure, StorageClass]
Implicitly added by Ops

Tries to attach another resource as the owner of this one. Can fail with com.coralogix.zio.k8s.client.UndefinedField if the owner does not have all the required metadata.

Tries to attach another resource as the owner of this one. Can fail with com.coralogix.zio.k8s.client.UndefinedField if the owner does not have all the required metadata.

Type parameters:
OwnerT

Type of the owner

Value parameters:
owner

Owner resource

Returns:

Object with the attached owner described in its metadata

Inherited from:
K8sObjectOps

Concrete fields

override protected val impl: K8sObject[StorageClass]
Implicitly added by Ops
protected val obj: StorageClass
Implicitly added by Ops