org.cdk8s.plus31.k8s.KubeStorageClassProps Maven / Gradle / Ivy
package org.cdk8s.plus31.k8s;
/**
* 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.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.105.0 (build 0a2adcb)", date = "2024-11-15T12:15:25.080Z")
@software.amazon.jsii.Jsii(module = org.cdk8s.plus31.$Module.class, fqn = "cdk8s-plus-31.k8s.KubeStorageClassProps")
@software.amazon.jsii.Jsii.Proxy(KubeStorageClassProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface KubeStorageClassProps extends software.amazon.jsii.JsiiSerializable {
/**
* provisioner indicates the type of the provisioner.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getProvisioner();
/**
* 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.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.util.List getAllowedTopologies() {
return null;
}
/**
* allowVolumeExpansion shows whether the storage class allow volume expand.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Boolean getAllowVolumeExpansion() {
return null;
}
/**
* Standard object's metadata.
*
* More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable org.cdk8s.plus31.k8s.ObjectMeta getMetadata() {
return null;
}
/**
* mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class.
*
* e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.util.List getMountOptions() {
return null;
}
/**
* parameters holds the parameters for the provisioner that should create volumes of this storage class.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.util.Map getParameters() {
return null;
}
/**
* reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class.
*
* Defaults to Delete.
*
* Default: Delete.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getReclaimPolicy() {
return null;
}
/**
* 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.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getVolumeBindingMode() {
return null;
}
/**
* @return a {@link Builder} of {@link KubeStorageClassProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link KubeStorageClassProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String provisioner;
java.util.List allowedTopologies;
java.lang.Boolean allowVolumeExpansion;
org.cdk8s.plus31.k8s.ObjectMeta metadata;
java.util.List mountOptions;
java.util.Map parameters;
java.lang.String reclaimPolicy;
java.lang.String volumeBindingMode;
/**
* Sets the value of {@link KubeStorageClassProps#getProvisioner}
* @param provisioner provisioner indicates the type of the provisioner. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder provisioner(java.lang.String provisioner) {
this.provisioner = provisioner;
return this;
}
/**
* Sets the value of {@link KubeStorageClassProps#getAllowedTopologies}
* @param allowedTopologies 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.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@SuppressWarnings("unchecked")
public Builder allowedTopologies(java.util.List allowedTopologies) {
this.allowedTopologies = (java.util.List)allowedTopologies;
return this;
}
/**
* Sets the value of {@link KubeStorageClassProps#getAllowVolumeExpansion}
* @param allowVolumeExpansion allowVolumeExpansion shows whether the storage class allow volume expand.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder allowVolumeExpansion(java.lang.Boolean allowVolumeExpansion) {
this.allowVolumeExpansion = allowVolumeExpansion;
return this;
}
/**
* Sets the value of {@link KubeStorageClassProps#getMetadata}
* @param metadata Standard object's metadata.
* More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder metadata(org.cdk8s.plus31.k8s.ObjectMeta metadata) {
this.metadata = metadata;
return this;
}
/**
* Sets the value of {@link KubeStorageClassProps#getMountOptions}
* @param mountOptions mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class.
* e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder mountOptions(java.util.List mountOptions) {
this.mountOptions = mountOptions;
return this;
}
/**
* Sets the value of {@link KubeStorageClassProps#getParameters}
* @param parameters parameters holds the parameters for the provisioner that should create volumes of this storage class.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder parameters(java.util.Map parameters) {
this.parameters = parameters;
return this;
}
/**
* Sets the value of {@link KubeStorageClassProps#getReclaimPolicy}
* @param reclaimPolicy reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class.
* Defaults to Delete.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder reclaimPolicy(java.lang.String reclaimPolicy) {
this.reclaimPolicy = reclaimPolicy;
return this;
}
/**
* Sets the value of {@link KubeStorageClassProps#getVolumeBindingMode}
* @param 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.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder volumeBindingMode(java.lang.String volumeBindingMode) {
this.volumeBindingMode = volumeBindingMode;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link KubeStorageClassProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public KubeStorageClassProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link KubeStorageClassProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements KubeStorageClassProps {
private final java.lang.String provisioner;
private final java.util.List allowedTopologies;
private final java.lang.Boolean allowVolumeExpansion;
private final org.cdk8s.plus31.k8s.ObjectMeta metadata;
private final java.util.List mountOptions;
private final java.util.Map parameters;
private final java.lang.String reclaimPolicy;
private final java.lang.String volumeBindingMode;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.provisioner = software.amazon.jsii.Kernel.get(this, "provisioner", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.allowedTopologies = software.amazon.jsii.Kernel.get(this, "allowedTopologies", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(org.cdk8s.plus31.k8s.TopologySelectorTerm.class)));
this.allowVolumeExpansion = software.amazon.jsii.Kernel.get(this, "allowVolumeExpansion", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
this.metadata = software.amazon.jsii.Kernel.get(this, "metadata", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus31.k8s.ObjectMeta.class));
this.mountOptions = software.amazon.jsii.Kernel.get(this, "mountOptions", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
this.parameters = software.amazon.jsii.Kernel.get(this, "parameters", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
this.reclaimPolicy = software.amazon.jsii.Kernel.get(this, "reclaimPolicy", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.volumeBindingMode = software.amazon.jsii.Kernel.get(this, "volumeBindingMode", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
@SuppressWarnings("unchecked")
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.provisioner = java.util.Objects.requireNonNull(builder.provisioner, "provisioner is required");
this.allowedTopologies = (java.util.List)builder.allowedTopologies;
this.allowVolumeExpansion = builder.allowVolumeExpansion;
this.metadata = builder.metadata;
this.mountOptions = builder.mountOptions;
this.parameters = builder.parameters;
this.reclaimPolicy = builder.reclaimPolicy;
this.volumeBindingMode = builder.volumeBindingMode;
}
@Override
public final java.lang.String getProvisioner() {
return this.provisioner;
}
@Override
public final java.util.List getAllowedTopologies() {
return this.allowedTopologies;
}
@Override
public final java.lang.Boolean getAllowVolumeExpansion() {
return this.allowVolumeExpansion;
}
@Override
public final org.cdk8s.plus31.k8s.ObjectMeta getMetadata() {
return this.metadata;
}
@Override
public final java.util.List getMountOptions() {
return this.mountOptions;
}
@Override
public final java.util.Map getParameters() {
return this.parameters;
}
@Override
public final java.lang.String getReclaimPolicy() {
return this.reclaimPolicy;
}
@Override
public final java.lang.String getVolumeBindingMode() {
return this.volumeBindingMode;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("provisioner", om.valueToTree(this.getProvisioner()));
if (this.getAllowedTopologies() != null) {
data.set("allowedTopologies", om.valueToTree(this.getAllowedTopologies()));
}
if (this.getAllowVolumeExpansion() != null) {
data.set("allowVolumeExpansion", om.valueToTree(this.getAllowVolumeExpansion()));
}
if (this.getMetadata() != null) {
data.set("metadata", om.valueToTree(this.getMetadata()));
}
if (this.getMountOptions() != null) {
data.set("mountOptions", om.valueToTree(this.getMountOptions()));
}
if (this.getParameters() != null) {
data.set("parameters", om.valueToTree(this.getParameters()));
}
if (this.getReclaimPolicy() != null) {
data.set("reclaimPolicy", om.valueToTree(this.getReclaimPolicy()));
}
if (this.getVolumeBindingMode() != null) {
data.set("volumeBindingMode", om.valueToTree(this.getVolumeBindingMode()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("cdk8s-plus-31.k8s.KubeStorageClassProps"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
KubeStorageClassProps.Jsii$Proxy that = (KubeStorageClassProps.Jsii$Proxy) o;
if (!provisioner.equals(that.provisioner)) return false;
if (this.allowedTopologies != null ? !this.allowedTopologies.equals(that.allowedTopologies) : that.allowedTopologies != null) return false;
if (this.allowVolumeExpansion != null ? !this.allowVolumeExpansion.equals(that.allowVolumeExpansion) : that.allowVolumeExpansion != null) return false;
if (this.metadata != null ? !this.metadata.equals(that.metadata) : that.metadata != null) return false;
if (this.mountOptions != null ? !this.mountOptions.equals(that.mountOptions) : that.mountOptions != null) return false;
if (this.parameters != null ? !this.parameters.equals(that.parameters) : that.parameters != null) return false;
if (this.reclaimPolicy != null ? !this.reclaimPolicy.equals(that.reclaimPolicy) : that.reclaimPolicy != null) return false;
return this.volumeBindingMode != null ? this.volumeBindingMode.equals(that.volumeBindingMode) : that.volumeBindingMode == null;
}
@Override
public final int hashCode() {
int result = this.provisioner.hashCode();
result = 31 * result + (this.allowedTopologies != null ? this.allowedTopologies.hashCode() : 0);
result = 31 * result + (this.allowVolumeExpansion != null ? this.allowVolumeExpansion.hashCode() : 0);
result = 31 * result + (this.metadata != null ? this.metadata.hashCode() : 0);
result = 31 * result + (this.mountOptions != null ? this.mountOptions.hashCode() : 0);
result = 31 * result + (this.parameters != null ? this.parameters.hashCode() : 0);
result = 31 * result + (this.reclaimPolicy != null ? this.reclaimPolicy.hashCode() : 0);
result = 31 * result + (this.volumeBindingMode != null ? this.volumeBindingMode.hashCode() : 0);
return result;
}
}
}