Package io.micronaut.kubernetes.client.openapi.model

Class V1CSIStorageCapacity

java.lang.Object
io.micronaut.kubernetes.client.openapi.model.V1CSIStorageCapacity
@Generated("io.micronaut.openapi.generator.JavaMicronautClientCodegen") public class V1CSIStorageCapacity extends Object
CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes. For example this can express things like: - StorageClass \"standard\" has \"1234 GiB\" available in \"topology.kubernetes.io/zone=us-east1\" - StorageClass \"localssd\" has \"10 GiB\" available in \"kubernetes.io/hostname=knode-abc123\" The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero The producer of these objects can decide which approach is more suitable. They are consumed by the kube-scheduler when a CSI driver opts into capacity-aware scheduling with CSIDriverSpec.StorageCapacity. The scheduler compares the MaximumVolumeSize against the requested size of pending volumes to filter out unsuitable nodes. If MaximumVolumeSize is unset, it falls back to a comparison against the less precise Capacity. If that is also unset, the scheduler assumes that capacity is insufficient and tries some other node.

  • Field Details

  • Constructor Details

    • V1CSIStorageCapacity

      public V1CSIStorageCapacity(String storageClassName)

  • Method Details

    • getStorageClassName

      public String getStorageClassName()
      storageClassName represents the name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.
      Returns:
      the storageClassName property value

    • setStorageClassName

      public void setStorageClassName(String storageClassName)
      Set the storageClassName property value
      Parameters:
      storageClassName - property value to set

    • storageClassName

      public V1CSIStorageCapacity storageClassName(String storageClassName)
      Set storageClassName in a chainable fashion.
      Returns:
      The same instance of V1CSIStorageCapacity for chaining.

    • 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
      Returns:
      the apiVersion property value

    • setApiVersion

      public void setApiVersion(String apiVersion)
      Set the apiVersion property value
      Parameters:
      apiVersion - property value to set

    • apiVersion

      public V1CSIStorageCapacity apiVersion(String apiVersion)
      Set apiVersion in a chainable fashion.
      Returns:
      The same instance of V1CSIStorageCapacity for chaining.

    • getCapacity

      public String getCapacity()
      Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ``` <quantity> ::= <signedNumber><suffix> (Note that <suffix> may be empty, from the \"\" case in <decimalSI>.) <digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= \"+\" | \"-\" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) <decimalSI> ::= m | \"\" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) <decimalExponent> ::= \"e\" <signedNumber> | \"E\" <signedNumber> ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in \"canonical form\". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as \"1500m\" - 1.5Gi will be serialized as \"1536Mi\" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.
      Returns:
      the capacity property value

    • setCapacity

      public void setCapacity(String capacity)
      Set the capacity property value
      Parameters:
      capacity - property value to set

    • capacity

      public V1CSIStorageCapacity capacity(String capacity)
      Set capacity in a chainable fashion.
      Returns:
      The same instance of V1CSIStorageCapacity for chaining.

    • 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
      Returns:
      the kind property value

    • setKind

      public void setKind(String kind)
      Set the kind property value
      Parameters:
      kind - property value to set

    • kind

      public V1CSIStorageCapacity kind(String kind)
      Set kind in a chainable fashion.
      Returns:
      The same instance of V1CSIStorageCapacity for chaining.

    • getMaximumVolumeSize

      public String getMaximumVolumeSize()
      Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ``` <quantity> ::= <signedNumber><suffix> (Note that <suffix> may be empty, from the \"\" case in <decimalSI>.) <digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= \"+\" | \"-\" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) <decimalSI> ::= m | \"\" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) <decimalExponent> ::= \"e\" <signedNumber> | \"E\" <signedNumber> ``` No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. Before serializing, Quantity will be put in \"canonical form\". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative. Examples: - 1.5 will be serialized as \"1500m\" - 1.5Gi will be serialized as \"1536Mi\" Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.
      Returns:
      the maximumVolumeSize property value

    • setMaximumVolumeSize

      public void setMaximumVolumeSize(String maximumVolumeSize)
      Set the maximumVolumeSize property value
      Parameters:
      maximumVolumeSize - property value to set

    • maximumVolumeSize

      public V1CSIStorageCapacity maximumVolumeSize(String maximumVolumeSize)
      Set maximumVolumeSize in a chainable fashion.
      Returns:
      The same instance of V1CSIStorageCapacity for chaining.

    • getMetadata

      public V1ObjectMeta getMetadata()
      Returns:
      the metadata property value

    • setMetadata

      public void setMetadata(V1ObjectMeta metadata)
      Set the metadata property value
      Parameters:
      metadata - property value to set

    • metadata

      public V1CSIStorageCapacity metadata(V1ObjectMeta metadata)
      Set metadata in a chainable fashion.
      Returns:
      The same instance of V1CSIStorageCapacity for chaining.

    • getNodeTopology

      public V1LabelSelector getNodeTopology()
      Returns:
      the nodeTopology property value

    • setNodeTopology

      public void setNodeTopology(V1LabelSelector nodeTopology)
      Set the nodeTopology property value
      Parameters:
      nodeTopology - property value to set

    • nodeTopology

      public V1CSIStorageCapacity nodeTopology(V1LabelSelector nodeTopology)
      Set nodeTopology in a chainable fashion.
      Returns:
      The same instance of V1CSIStorageCapacity for chaining.

    • 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