Package org.cdk8s.plus24.k8s

Class PersistentVolumeClaimSpec.Builder

java.lang.Object

org.cdk8s.plus24.k8s.PersistentVolumeClaimSpec.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PersistentVolumeClaimSpec>

Enclosing interface:

PersistentVolumeClaimSpec

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

A builder for PersistentVolumeClaimSpec

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PersistentVolumeClaimSpec.Builder	accessModes(List<String> accessModes)	Sets the value of PersistentVolumeClaimSpec.getAccessModes()
PersistentVolumeClaimSpec	build()	Builds the configured instance.
PersistentVolumeClaimSpec.Builder	dataSource(TypedLocalObjectReference dataSource)	Sets the value of PersistentVolumeClaimSpec.getDataSource()
PersistentVolumeClaimSpec.Builder	dataSourceRef(TypedLocalObjectReference dataSourceRef)	Sets the value of PersistentVolumeClaimSpec.getDataSourceRef()
PersistentVolumeClaimSpec.Builder	resources(ResourceRequirements resources)	Sets the value of PersistentVolumeClaimSpec.getResources()
PersistentVolumeClaimSpec.Builder	selector(LabelSelector selector)	Sets the value of PersistentVolumeClaimSpec.getSelector()
PersistentVolumeClaimSpec.Builder	storageClassName(String storageClassName)	Sets the value of PersistentVolumeClaimSpec.getStorageClassName()
PersistentVolumeClaimSpec.Builder	volumeMode(String volumeMode)	Sets the value of PersistentVolumeClaimSpec.getVolumeMode()
PersistentVolumeClaimSpec.Builder	volumeName(String volumeName)	Sets the value of PersistentVolumeClaimSpec.getVolumeName()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

accessModes

@Stability(Stable)
public PersistentVolumeClaimSpec.Builder accessModes(List<String> accessModes)

Sets the value of PersistentVolumeClaimSpec.getAccessModes()

Parameters:

accessModes - accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

Returns:

this

dataSource

@Stability(Stable)
public PersistentVolumeClaimSpec.Builder dataSource(TypedLocalObjectReference dataSource)

Sets the value of PersistentVolumeClaimSpec.getDataSource()

Parameters:

dataSource - dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

Returns:

this

dataSourceRef

@Stability(Stable)
public PersistentVolumeClaimSpec.Builder dataSourceRef(TypedLocalObjectReference dataSourceRef)

Sets the value of PersistentVolumeClaimSpec.getDataSourceRef()

Parameters:

dataSourceRef - dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.

• While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

Returns:

this

resources

@Stability(Stable)
public PersistentVolumeClaimSpec.Builder resources(ResourceRequirements resources)

Sets the value of PersistentVolumeClaimSpec.getResources()

Parameters:

resources - resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

Returns:

this

selector

@Stability(Stable)
public PersistentVolumeClaimSpec.Builder selector(LabelSelector selector)

Sets the value of PersistentVolumeClaimSpec.getSelector()

Parameters:

selector - selector is a label query over volumes to consider for binding.

Returns:

this

storageClassName

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

Sets the value of PersistentVolumeClaimSpec.getStorageClassName()

Parameters:

storageClassName - storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

Returns:

this

volumeMode

@Stability(Stable)
public PersistentVolumeClaimSpec.Builder volumeMode(String volumeMode)

Sets the value of PersistentVolumeClaimSpec.getVolumeMode()

Parameters:

volumeMode - volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

Returns:

this

volumeName

@Stability(Stable)
public PersistentVolumeClaimSpec.Builder volumeName(String volumeName)

Sets the value of PersistentVolumeClaimSpec.getVolumeName()

Parameters:

volumeName - volumeName is the binding reference to the PersistentVolume backing this claim.

Returns:

this

build

@Stability(Stable)
public PersistentVolumeClaimSpec build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of PersistentVolumeClaimSpec

Throws:

NullPointerException - if any required attribute was not provided