V1CSIStorageCapacity (client-java-api 16.0.0 API)

java.lang.Object
- io.kubernetes.client.openapi.models.V1CSIStorageCapacity

All Implemented Interfaces:

KubernetesObject, KubernetesType
```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-05-06T16:45:00.555Z[Etc/UTC]")
public class V1CSIStorageCapacity
extends Object
implements KubernetesObject
```
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 Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_API_VERSION`
`static String`	`SERIALIZED_NAME_CAPACITY`
`static String`	`SERIALIZED_NAME_KIND`
`static String`	`SERIALIZED_NAME_MAXIMUM_VOLUME_SIZE`
`static String`	`SERIALIZED_NAME_METADATA`
`static String`	`SERIALIZED_NAME_NODE_TOPOLOGY`
`static String`	`SERIALIZED_NAME_STORAGE_CLASS_NAME`

Constructor Summary

Constructors
Constructor and Description

V1CSIStorageCapacity()

Constructors
Constructor and Description
`V1CSIStorageCapacity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`V1CSIStorageCapacity`	`apiVersion(String apiVersion)`
`V1CSIStorageCapacity`	`capacity(Quantity capacity)`
`boolean`	`equals(Object o)`
`String`	`getApiVersion()` APIVersion defines the versioned schema of this representation of an object.
`Quantity`	`getCapacity()` Quantity is a fixed-point representation of a number.
`String`	`getKind()` Kind is a string value representing the REST resource this object represents.
`Quantity`	`getMaximumVolumeSize()` Quantity is a fixed-point representation of a number.
`V1ObjectMeta`	`getMetadata()` Get metadata
`V1LabelSelector`	`getNodeTopology()` Get nodeTopology
`String`	`getStorageClassName()` The name of the StorageClass that the reported capacity applies to.
`int`	`hashCode()`
`V1CSIStorageCapacity`	`kind(String kind)`
`V1CSIStorageCapacity`	`maximumVolumeSize(Quantity maximumVolumeSize)`
`V1CSIStorageCapacity`	`metadata(V1ObjectMeta metadata)`
`V1CSIStorageCapacity`	`nodeTopology(V1LabelSelector nodeTopology)`
`void`	`setApiVersion(String apiVersion)`
`void`	`setCapacity(Quantity capacity)`
`void`	`setKind(String kind)`
`void`	`setMaximumVolumeSize(Quantity maximumVolumeSize)`
`void`	`setMetadata(V1ObjectMeta metadata)`
`void`	`setNodeTopology(V1LabelSelector nodeTopology)`
`void`	`setStorageClassName(String storageClassName)`
`V1CSIStorageCapacity`	`storageClassName(String storageClassName)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_API_VERSION
```
public static final String SERIALIZED_NAME_API_VERSION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CAPACITY
```
public static final String SERIALIZED_NAME_CAPACITY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_KIND
```
public static final String SERIALIZED_NAME_KIND
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MAXIMUM_VOLUME_SIZE
```
public static final String SERIALIZED_NAME_MAXIMUM_VOLUME_SIZE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_METADATA
```
public static final String SERIALIZED_NAME_METADATA
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NODE_TOPOLOGY
```
public static final String SERIALIZED_NAME_NODE_TOPOLOGY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STORAGE_CLASS_NAME
```
public static final String SERIALIZED_NAME_STORAGE_CLASS_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - V1CSIStorageCapacity
```
public V1CSIStorageCapacity()
```
- Method Detail
  - apiVersion
```
public V1CSIStorageCapacity apiVersion(String apiVersion)
```
  - getApiVersion
```
@Nullable
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 KubernetesType
    
    Returns:
    
    apiVersion
  - setApiVersion
```
public void setApiVersion(String apiVersion)
```
  - capacity
```
public V1CSIStorageCapacity capacity(Quantity capacity)
```
  - getCapacity
```
@Nullable
public Quantity 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: a. No precision is lost b. No fractional digits will be emitted c. 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:
    
    capacity
  - setCapacity
```
public void setCapacity(Quantity capacity)
```
  - kind
```
public V1CSIStorageCapacity kind(String kind)
```
  - getKind
```
@Nullable
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 KubernetesType
    
    Returns:
    
    kind
  - setKind
```
public void setKind(String kind)
```
  - maximumVolumeSize
```
public V1CSIStorageCapacity maximumVolumeSize(Quantity maximumVolumeSize)
```
  - getMaximumVolumeSize
```
@Nullable
public Quantity 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: a. No precision is lost b. No fractional digits will be emitted c. 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:
    
    maximumVolumeSize
  - setMaximumVolumeSize
```
public void setMaximumVolumeSize(Quantity maximumVolumeSize)
```
  - metadata
```
public V1CSIStorageCapacity metadata(V1ObjectMeta metadata)
```
  - getMetadata
```
@Nullable
public V1ObjectMeta getMetadata()
```
    Get metadata
    
    Specified by:
    
    getMetadata in interface KubernetesObject
    
    Returns:
    
    metadata
  - setMetadata
```
public void setMetadata(V1ObjectMeta metadata)
```
  - nodeTopology
```
public V1CSIStorageCapacity nodeTopology(V1LabelSelector nodeTopology)
```
  - getNodeTopology
```
@Nullable
public V1LabelSelector getNodeTopology()
```
    Get nodeTopology
    
    Returns:
    
    nodeTopology
  - setNodeTopology
```
public void setNodeTopology(V1LabelSelector nodeTopology)
```
  - storageClassName
```
public V1CSIStorageCapacity storageClassName(String storageClassName)
```
  - getStorageClassName
```
public String getStorageClassName()
```
    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:
    
    storageClassName
  - setStorageClassName
```
public void setStorageClassName(String storageClassName)
```
  - 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

Class V1CSIStorageCapacity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_API_VERSION

SERIALIZED_NAME_CAPACITY

SERIALIZED_NAME_KIND

SERIALIZED_NAME_MAXIMUM_VOLUME_SIZE

SERIALIZED_NAME_METADATA

SERIALIZED_NAME_NODE_TOPOLOGY

SERIALIZED_NAME_STORAGE_CLASS_NAME

Constructor Detail

V1CSIStorageCapacity

Method Detail

apiVersion

getApiVersion

setApiVersion

capacity

getCapacity

setCapacity

kind

getKind

setKind

maximumVolumeSize

getMaximumVolumeSize

setMaximumVolumeSize

metadata

getMetadata

setMetadata

nodeTopology

getNodeTopology

setNodeTopology

storageClassName

getStorageClassName

setStorageClassName

equals

hashCode

toString