org.cdk8s.plus22.PathMapping Maven / Gradle / Ivy
Show all versions of cdk8s-plus-22 Show documentation
package org.cdk8s.plus22;
/**
* Maps a string key to a path within a volume.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.47.0 (build 86d2c33)", date = "2021-12-08T00:16:55.108Z")
@software.amazon.jsii.Jsii(module = org.cdk8s.plus22.$Module.class, fqn = "cdk8s-plus-22.PathMapping")
@software.amazon.jsii.Jsii.Proxy(PathMapping.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface PathMapping extends software.amazon.jsii.JsiiSerializable {
/**
* The relative path of the file to map the key to.
*
* May not be an absolute
* path. May not contain the path element '..'. May not start with the string
* '..'.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getPath();
/**
* Optional: mode bits to use on this file, must be a value between 0 and 0777.
*
* If not specified, the volume defaultMode will be used. This might be
* in conflict with other options that affect the file mode, like fsGroup, and
* the result can be other mode bits set.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Number getMode() {
return null;
}
/**
* @return a {@link Builder} of {@link PathMapping}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link PathMapping}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String path;
java.lang.Number mode;
/**
* Sets the value of {@link PathMapping#getPath}
* @param path The relative path of the file to map the key to. This parameter is required.
* May not be an absolute
* path. May not contain the path element '..'. May not start with the string
* '..'.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder path(java.lang.String path) {
this.path = path;
return this;
}
/**
* Sets the value of {@link PathMapping#getMode}
* @param mode Optional: mode bits to use on this file, must be a value between 0 and 0777.
* If not specified, the volume defaultMode will be used. This might be
* in conflict with other options that affect the file mode, like fsGroup, and
* the result can be other mode bits set.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder mode(java.lang.Number mode) {
this.mode = mode;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link PathMapping}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public PathMapping build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link PathMapping}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements PathMapping {
private final java.lang.String path;
private final java.lang.Number mode;
/**
* 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.path = software.amazon.jsii.Kernel.get(this, "path", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.mode = software.amazon.jsii.Kernel.get(this, "mode", software.amazon.jsii.NativeType.forClass(java.lang.Number.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.path = java.util.Objects.requireNonNull(builder.path, "path is required");
this.mode = builder.mode;
}
@Override
public final java.lang.String getPath() {
return this.path;
}
@Override
public final java.lang.Number getMode() {
return this.mode;
}
@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("path", om.valueToTree(this.getPath()));
if (this.getMode() != null) {
data.set("mode", om.valueToTree(this.getMode()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("cdk8s-plus-22.PathMapping"));
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;
PathMapping.Jsii$Proxy that = (PathMapping.Jsii$Proxy) o;
if (!path.equals(that.path)) return false;
return this.mode != null ? this.mode.equals(that.mode) : that.mode == null;
}
@Override
public final int hashCode() {
int result = this.path.hashCode();
result = 31 * result + (this.mode != null ? this.mode.hashCode() : 0);
return result;
}
}
}