Package org.cdk8s.plus23.k8s

Class KubeCsiStorageCapacityV1Alpha1.Builder

java.lang.Object

org.cdk8s.plus23.k8s.KubeCsiStorageCapacityV1Alpha1.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<KubeCsiStorageCapacityV1Alpha1>

Enclosing class:

KubeCsiStorageCapacityV1Alpha1

@Stability(Stable)
public static final class KubeCsiStorageCapacityV1Alpha1.Builder
extends Object
implements software.amazon.jsii.Builder<KubeCsiStorageCapacityV1Alpha1>

A fluent builder for KubeCsiStorageCapacityV1Alpha1.

Method Summary

Modifier and Type	Method	Description
KubeCsiStorageCapacityV1Alpha1	build()
KubeCsiStorageCapacityV1Alpha1.Builder	capacity(Quantity capacity)	Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.
static KubeCsiStorageCapacityV1Alpha1.Builder	create(software.constructs.Construct scope, String id)
KubeCsiStorageCapacityV1Alpha1.Builder	maximumVolumeSize(Quantity maximumVolumeSize)	MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.
KubeCsiStorageCapacityV1Alpha1.Builder	metadata(ObjectMeta metadata)	Standard object's metadata.
KubeCsiStorageCapacityV1Alpha1.Builder	nodeTopology(LabelSelector nodeTopology)	NodeTopology defines which nodes have access to the storage for which capacity was reported.
KubeCsiStorageCapacityV1Alpha1.Builder	storageClassName(String storageClassName)	The name of the StorageClass that the reported capacity applies to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(Stable)
public static KubeCsiStorageCapacityV1Alpha1.Builder create(software.constructs.Construct scope,
                                                            String id)

Parameters:

scope - the scope in which to define this object. This parameter is required.

id - a scope-local name for the object. This parameter is required.

Returns:

a new instance of KubeCsiStorageCapacityV1Alpha1.Builder.

storageClassName

@Stability(Stable)
public KubeCsiStorageCapacityV1Alpha1.Builder storageClassName(String storageClassName)

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.

Parameters:

storageClassName - The name of the StorageClass that the reported capacity applies to. This parameter is required.

Returns:

this

capacity

@Stability(Stable)
public KubeCsiStorageCapacityV1Alpha1.Builder capacity(Quantity capacity)

Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.

The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity.

Parameters:

capacity - Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. This parameter is required.

Returns:

this

maximumVolumeSize

@Stability(Stable)
public KubeCsiStorageCapacityV1Alpha1.Builder maximumVolumeSize(Quantity maximumVolumeSize)

MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.

This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim.

Parameters:

maximumVolumeSize - MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. This parameter is required.

Returns:

this

metadata

@Stability(Stable)
public KubeCsiStorageCapacityV1Alpha1.Builder metadata(ObjectMeta metadata)

Standard object's metadata.

The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-, a generated name, or a reverse-domain name which ends with the unique CSI driver name.

Objects are namespaced.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Parameters:

metadata - Standard object's metadata. This parameter is required.

Returns:

this

nodeTopology

@Stability(Stable)
public KubeCsiStorageCapacityV1Alpha1.Builder nodeTopology(LabelSelector nodeTopology)

NodeTopology defines which nodes have access to the storage for which capacity was reported.

If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable.

Parameters:

nodeTopology - NodeTopology defines which nodes have access to the storage for which capacity was reported. This parameter is required.

Returns:

this

build

@Stability(Stable)
public KubeCsiStorageCapacityV1Alpha1 build()

Specified by:

build in interface software.amazon.jsii.Builder<KubeCsiStorageCapacityV1Alpha1>