org.cdk8s.plus23.k8s.CsiPersistentVolumeSource Maven / Gradle / Ivy
package org.cdk8s.plus23.k8s;
/**
* Represents storage that is managed by an external CSI volume driver (Beta feature).
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.75.0 (build 63bb957)", date = "2023-02-21T09:46:03.754Z")
@software.amazon.jsii.Jsii(module = org.cdk8s.plus23.$Module.class, fqn = "cdk8s-plus-23.k8s.CsiPersistentVolumeSource")
@software.amazon.jsii.Jsii.Proxy(CsiPersistentVolumeSource.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface CsiPersistentVolumeSource extends software.amazon.jsii.JsiiSerializable {
/**
* Driver is the name of the driver to use for this volume.
*
* Required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getDriver();
/**
* VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls.
*
* Required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getVolumeHandle();
/**
* ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call.
*
* This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable org.cdk8s.plus23.k8s.SecretReference getControllerExpandSecretRef() {
return null;
}
/**
* ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls.
*
* This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable org.cdk8s.plus23.k8s.SecretReference getControllerPublishSecretRef() {
return null;
}
/**
* Filesystem type to mount.
*
* Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getFsType() {
return null;
}
/**
* NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls.
*
* This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable org.cdk8s.plus23.k8s.SecretReference getNodePublishSecretRef() {
return null;
}
/**
* NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls.
*
* This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable org.cdk8s.plus23.k8s.SecretReference getNodeStageSecretRef() {
return null;
}
/**
* Optional: The value to pass to ControllerPublishVolumeRequest.
*
* Defaults to false (read/write).
*
* Default: false (read/write).
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Boolean getReadOnly() {
return null;
}
/**
* Attributes of the volume to publish.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.util.Map getVolumeAttributes() {
return null;
}
/**
* @return a {@link Builder} of {@link CsiPersistentVolumeSource}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link CsiPersistentVolumeSource}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String driver;
java.lang.String volumeHandle;
org.cdk8s.plus23.k8s.SecretReference controllerExpandSecretRef;
org.cdk8s.plus23.k8s.SecretReference controllerPublishSecretRef;
java.lang.String fsType;
org.cdk8s.plus23.k8s.SecretReference nodePublishSecretRef;
org.cdk8s.plus23.k8s.SecretReference nodeStageSecretRef;
java.lang.Boolean readOnly;
java.util.Map volumeAttributes;
/**
* Sets the value of {@link CsiPersistentVolumeSource#getDriver}
* @param driver Driver is the name of the driver to use for this volume. This parameter is required.
* Required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder driver(java.lang.String driver) {
this.driver = driver;
return this;
}
/**
* Sets the value of {@link CsiPersistentVolumeSource#getVolumeHandle}
* @param volumeHandle VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. This parameter is required.
* Required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder volumeHandle(java.lang.String volumeHandle) {
this.volumeHandle = volumeHandle;
return this;
}
/**
* Sets the value of {@link CsiPersistentVolumeSource#getControllerExpandSecretRef}
* @param controllerExpandSecretRef ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call.
* This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder controllerExpandSecretRef(org.cdk8s.plus23.k8s.SecretReference controllerExpandSecretRef) {
this.controllerExpandSecretRef = controllerExpandSecretRef;
return this;
}
/**
* Sets the value of {@link CsiPersistentVolumeSource#getControllerPublishSecretRef}
* @param controllerPublishSecretRef ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls.
* This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder controllerPublishSecretRef(org.cdk8s.plus23.k8s.SecretReference controllerPublishSecretRef) {
this.controllerPublishSecretRef = controllerPublishSecretRef;
return this;
}
/**
* Sets the value of {@link CsiPersistentVolumeSource#getFsType}
* @param fsType Filesystem type to mount.
* Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder fsType(java.lang.String fsType) {
this.fsType = fsType;
return this;
}
/**
* Sets the value of {@link CsiPersistentVolumeSource#getNodePublishSecretRef}
* @param nodePublishSecretRef NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls.
* This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder nodePublishSecretRef(org.cdk8s.plus23.k8s.SecretReference nodePublishSecretRef) {
this.nodePublishSecretRef = nodePublishSecretRef;
return this;
}
/**
* Sets the value of {@link CsiPersistentVolumeSource#getNodeStageSecretRef}
* @param nodeStageSecretRef NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls.
* This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder nodeStageSecretRef(org.cdk8s.plus23.k8s.SecretReference nodeStageSecretRef) {
this.nodeStageSecretRef = nodeStageSecretRef;
return this;
}
/**
* Sets the value of {@link CsiPersistentVolumeSource#getReadOnly}
* @param readOnly Optional: The value to pass to ControllerPublishVolumeRequest.
* Defaults to false (read/write).
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder readOnly(java.lang.Boolean readOnly) {
this.readOnly = readOnly;
return this;
}
/**
* Sets the value of {@link CsiPersistentVolumeSource#getVolumeAttributes}
* @param volumeAttributes Attributes of the volume to publish.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder volumeAttributes(java.util.Map volumeAttributes) {
this.volumeAttributes = volumeAttributes;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link CsiPersistentVolumeSource}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public CsiPersistentVolumeSource build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link CsiPersistentVolumeSource}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CsiPersistentVolumeSource {
private final java.lang.String driver;
private final java.lang.String volumeHandle;
private final org.cdk8s.plus23.k8s.SecretReference controllerExpandSecretRef;
private final org.cdk8s.plus23.k8s.SecretReference controllerPublishSecretRef;
private final java.lang.String fsType;
private final org.cdk8s.plus23.k8s.SecretReference nodePublishSecretRef;
private final org.cdk8s.plus23.k8s.SecretReference nodeStageSecretRef;
private final java.lang.Boolean readOnly;
private final java.util.Map volumeAttributes;
/**
* 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.driver = software.amazon.jsii.Kernel.get(this, "driver", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.volumeHandle = software.amazon.jsii.Kernel.get(this, "volumeHandle", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.controllerExpandSecretRef = software.amazon.jsii.Kernel.get(this, "controllerExpandSecretRef", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus23.k8s.SecretReference.class));
this.controllerPublishSecretRef = software.amazon.jsii.Kernel.get(this, "controllerPublishSecretRef", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus23.k8s.SecretReference.class));
this.fsType = software.amazon.jsii.Kernel.get(this, "fsType", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.nodePublishSecretRef = software.amazon.jsii.Kernel.get(this, "nodePublishSecretRef", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus23.k8s.SecretReference.class));
this.nodeStageSecretRef = software.amazon.jsii.Kernel.get(this, "nodeStageSecretRef", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus23.k8s.SecretReference.class));
this.readOnly = software.amazon.jsii.Kernel.get(this, "readOnly", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
this.volumeAttributes = software.amazon.jsii.Kernel.get(this, "volumeAttributes", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.driver = java.util.Objects.requireNonNull(builder.driver, "driver is required");
this.volumeHandle = java.util.Objects.requireNonNull(builder.volumeHandle, "volumeHandle is required");
this.controllerExpandSecretRef = builder.controllerExpandSecretRef;
this.controllerPublishSecretRef = builder.controllerPublishSecretRef;
this.fsType = builder.fsType;
this.nodePublishSecretRef = builder.nodePublishSecretRef;
this.nodeStageSecretRef = builder.nodeStageSecretRef;
this.readOnly = builder.readOnly;
this.volumeAttributes = builder.volumeAttributes;
}
@Override
public final java.lang.String getDriver() {
return this.driver;
}
@Override
public final java.lang.String getVolumeHandle() {
return this.volumeHandle;
}
@Override
public final org.cdk8s.plus23.k8s.SecretReference getControllerExpandSecretRef() {
return this.controllerExpandSecretRef;
}
@Override
public final org.cdk8s.plus23.k8s.SecretReference getControllerPublishSecretRef() {
return this.controllerPublishSecretRef;
}
@Override
public final java.lang.String getFsType() {
return this.fsType;
}
@Override
public final org.cdk8s.plus23.k8s.SecretReference getNodePublishSecretRef() {
return this.nodePublishSecretRef;
}
@Override
public final org.cdk8s.plus23.k8s.SecretReference getNodeStageSecretRef() {
return this.nodeStageSecretRef;
}
@Override
public final java.lang.Boolean getReadOnly() {
return this.readOnly;
}
@Override
public final java.util.Map getVolumeAttributes() {
return this.volumeAttributes;
}
@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("driver", om.valueToTree(this.getDriver()));
data.set("volumeHandle", om.valueToTree(this.getVolumeHandle()));
if (this.getControllerExpandSecretRef() != null) {
data.set("controllerExpandSecretRef", om.valueToTree(this.getControllerExpandSecretRef()));
}
if (this.getControllerPublishSecretRef() != null) {
data.set("controllerPublishSecretRef", om.valueToTree(this.getControllerPublishSecretRef()));
}
if (this.getFsType() != null) {
data.set("fsType", om.valueToTree(this.getFsType()));
}
if (this.getNodePublishSecretRef() != null) {
data.set("nodePublishSecretRef", om.valueToTree(this.getNodePublishSecretRef()));
}
if (this.getNodeStageSecretRef() != null) {
data.set("nodeStageSecretRef", om.valueToTree(this.getNodeStageSecretRef()));
}
if (this.getReadOnly() != null) {
data.set("readOnly", om.valueToTree(this.getReadOnly()));
}
if (this.getVolumeAttributes() != null) {
data.set("volumeAttributes", om.valueToTree(this.getVolumeAttributes()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("cdk8s-plus-23.k8s.CsiPersistentVolumeSource"));
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;
CsiPersistentVolumeSource.Jsii$Proxy that = (CsiPersistentVolumeSource.Jsii$Proxy) o;
if (!driver.equals(that.driver)) return false;
if (!volumeHandle.equals(that.volumeHandle)) return false;
if (this.controllerExpandSecretRef != null ? !this.controllerExpandSecretRef.equals(that.controllerExpandSecretRef) : that.controllerExpandSecretRef != null) return false;
if (this.controllerPublishSecretRef != null ? !this.controllerPublishSecretRef.equals(that.controllerPublishSecretRef) : that.controllerPublishSecretRef != null) return false;
if (this.fsType != null ? !this.fsType.equals(that.fsType) : that.fsType != null) return false;
if (this.nodePublishSecretRef != null ? !this.nodePublishSecretRef.equals(that.nodePublishSecretRef) : that.nodePublishSecretRef != null) return false;
if (this.nodeStageSecretRef != null ? !this.nodeStageSecretRef.equals(that.nodeStageSecretRef) : that.nodeStageSecretRef != null) return false;
if (this.readOnly != null ? !this.readOnly.equals(that.readOnly) : that.readOnly != null) return false;
return this.volumeAttributes != null ? this.volumeAttributes.equals(that.volumeAttributes) : that.volumeAttributes == null;
}
@Override
public final int hashCode() {
int result = this.driver.hashCode();
result = 31 * result + (this.volumeHandle.hashCode());
result = 31 * result + (this.controllerExpandSecretRef != null ? this.controllerExpandSecretRef.hashCode() : 0);
result = 31 * result + (this.controllerPublishSecretRef != null ? this.controllerPublishSecretRef.hashCode() : 0);
result = 31 * result + (this.fsType != null ? this.fsType.hashCode() : 0);
result = 31 * result + (this.nodePublishSecretRef != null ? this.nodePublishSecretRef.hashCode() : 0);
result = 31 * result + (this.nodeStageSecretRef != null ? this.nodeStageSecretRef.hashCode() : 0);
result = 31 * result + (this.readOnly != null ? this.readOnly.hashCode() : 0);
result = 31 * result + (this.volumeAttributes != null ? this.volumeAttributes.hashCode() : 0);
return result;
}
}
}