org.cdk8s.plus31.k8s.ValidationV1Alpha1 Maven / Gradle / Ivy
package org.cdk8s.plus31.k8s;
/**
* Validation specifies the CEL expression which is used to apply the validation.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.104.0 (build e79254c)", date = "2024-10-12T12:14:17.744Z")
@software.amazon.jsii.Jsii(module = org.cdk8s.plus31.$Module.class, fqn = "cdk8s-plus-31.k8s.ValidationV1Alpha1")
@software.amazon.jsii.Jsii.Proxy(ValidationV1Alpha1.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface ValidationV1Alpha1 extends software.amazon.jsii.JsiiSerializable {
/**
* Expression represents the expression which will be evaluated by CEL.
*
* ref: https://github.com/google/cel-spec CEL expressions have access to the contents of the API request/response, organized into CEL variables as well as some other useful variables:
*
*
* - 'object' - The object from the incoming request. The value is null for DELETE requests. - 'oldObject' - The existing object. The value is null for CREATE requests. - 'request' - Attributes of the API request(ref). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources. - 'variables' - Map of composited variables, from its name to its lazily evaluated value.
* For example, a variable named 'foo' can be accessed as 'variables.foo'.
* - 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.
* See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
* - 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the
* request resource.
*
*
* The apiVersion, kind, metadata.name and metadata.generateName are always accessible from the root of the object. No other metadata properties are accessible.
*
* Only property names of the form [a-zA-Z_.-/][a-zA-Z0-9_.-/]* are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '' escapes to 'underscores' - '.' escapes to 'dot' - '-' escapes to 'dash' - '/' escapes to 'slash' - Property names that exactly match a CEL RESERVED keyword escape to '{keyword}__'. The keywords are:
* "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if",
* "import", "let", "loop", "package", "namespace", "return".
* Examples:
*
*
* - Expression accessing a property named "namespace": {"Expression": "object.namespace > 0"}
* - Expression accessing a property named "x-prop": {"Expression": "object.x__dash__prop > 0"}
* - Expression accessing a property named "redact__d": {"Expression": "object.redact__underscores__d > 0"}
*
*
* Equality on arrays with list type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
*
*
* - 'set':
X + Y performs a union where the array positions of all elements in X are preserved and
* non-intersecting elements in Y are appended, retaining their partial order.
* - 'map':
X + Y performs a merge where the array positions of all keys in X are preserved but the values
* are overwritten by values in Y when the key sets of X and Y intersect. Elements in Y with
* non-intersecting keys are appended, retaining their partial order.
* Required.
*
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getExpression();
/**
* Message represents the message displayed when validation fails.
*
* The message is required if the Expression contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" If the Expression contains line breaks. Message is required. The message must not contain line breaks. If unset, the message is "failed Expression: {Expression}".
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getMessage() {
return null;
}
/**
* messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails.
*
* Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a validation, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the expression except for 'authorizer' and 'authorizer.requestResource'. Example: "object.x must be less than max ("+string(params.max)+")"
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getMessageExpression() {
return null;
}
/**
* Reason represents a machine-readable description of why this validation failed.
*
* If this is the first validation in the list to fail, this reason, as well as the corresponding HTTP response code, are used in the HTTP response to the client. The currently supported reasons are: "Unauthorized", "Forbidden", "Invalid", "RequestEntityTooLarge". If not set, StatusReasonInvalid is used in the response to the client.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getReason() {
return null;
}
/**
* @return a {@link Builder} of {@link ValidationV1Alpha1}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link ValidationV1Alpha1}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String expression;
java.lang.String message;
java.lang.String messageExpression;
java.lang.String reason;
/**
* Sets the value of {@link ValidationV1Alpha1#getExpression}
* @param expression Expression represents the expression which will be evaluated by CEL. This parameter is required.
* ref: https://github.com/google/cel-spec CEL expressions have access to the contents of the API request/response, organized into CEL variables as well as some other useful variables:
*
*
* - 'object' - The object from the incoming request. The value is null for DELETE requests. - 'oldObject' - The existing object. The value is null for CREATE requests. - 'request' - Attributes of the API request(ref). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources. - 'variables' - Map of composited variables, from its name to its lazily evaluated value.
* For example, a variable named 'foo' can be accessed as 'variables.foo'.
* - 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.
* See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
* - 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the
* request resource.
*
*
* The apiVersion, kind, metadata.name and metadata.generateName are always accessible from the root of the object. No other metadata properties are accessible.
*
* Only property names of the form [a-zA-Z_.-/][a-zA-Z0-9_.-/]* are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '' escapes to 'underscores' - '.' escapes to 'dot' - '-' escapes to 'dash' - '/' escapes to 'slash' - Property names that exactly match a CEL RESERVED keyword escape to '{keyword}__'. The keywords are:
* "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if",
* "import", "let", "loop", "package", "namespace", "return".
* Examples:
*
*
* - Expression accessing a property named "namespace": {"Expression": "object.namespace > 0"}
* - Expression accessing a property named "x-prop": {"Expression": "object.x__dash__prop > 0"}
* - Expression accessing a property named "redact__d": {"Expression": "object.redact__underscores__d > 0"}
*
*
* Equality on arrays with list type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
*
*
* - 'set':
X + Y performs a union where the array positions of all elements in X are preserved and
* non-intersecting elements in Y are appended, retaining their partial order.
* - 'map':
X + Y performs a merge where the array positions of all keys in X are preserved but the values
* are overwritten by values in Y when the key sets of X and Y intersect. Elements in Y with
* non-intersecting keys are appended, retaining their partial order.
* Required.
*
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder expression(java.lang.String expression) {
this.expression = expression;
return this;
}
/**
* Sets the value of {@link ValidationV1Alpha1#getMessage}
* @param message Message represents the message displayed when validation fails.
* The message is required if the Expression contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" If the Expression contains line breaks. Message is required. The message must not contain line breaks. If unset, the message is "failed Expression: {Expression}".
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder message(java.lang.String message) {
this.message = message;
return this;
}
/**
* Sets the value of {@link ValidationV1Alpha1#getMessageExpression}
* @param messageExpression messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails.
* Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a validation, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the expression except for 'authorizer' and 'authorizer.requestResource'. Example: "object.x must be less than max ("+string(params.max)+")"
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder messageExpression(java.lang.String messageExpression) {
this.messageExpression = messageExpression;
return this;
}
/**
* Sets the value of {@link ValidationV1Alpha1#getReason}
* @param reason Reason represents a machine-readable description of why this validation failed.
* If this is the first validation in the list to fail, this reason, as well as the corresponding HTTP response code, are used in the HTTP response to the client. The currently supported reasons are: "Unauthorized", "Forbidden", "Invalid", "RequestEntityTooLarge". If not set, StatusReasonInvalid is used in the response to the client.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder reason(java.lang.String reason) {
this.reason = reason;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link ValidationV1Alpha1}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public ValidationV1Alpha1 build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link ValidationV1Alpha1}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ValidationV1Alpha1 {
private final java.lang.String expression;
private final java.lang.String message;
private final java.lang.String messageExpression;
private final java.lang.String reason;
/**
* 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.expression = software.amazon.jsii.Kernel.get(this, "expression", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.message = software.amazon.jsii.Kernel.get(this, "message", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.messageExpression = software.amazon.jsii.Kernel.get(this, "messageExpression", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.reason = software.amazon.jsii.Kernel.get(this, "reason", 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.expression = java.util.Objects.requireNonNull(builder.expression, "expression is required");
this.message = builder.message;
this.messageExpression = builder.messageExpression;
this.reason = builder.reason;
}
@Override
public final java.lang.String getExpression() {
return this.expression;
}
@Override
public final java.lang.String getMessage() {
return this.message;
}
@Override
public final java.lang.String getMessageExpression() {
return this.messageExpression;
}
@Override
public final java.lang.String getReason() {
return this.reason;
}
@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("expression", om.valueToTree(this.getExpression()));
if (this.getMessage() != null) {
data.set("message", om.valueToTree(this.getMessage()));
}
if (this.getMessageExpression() != null) {
data.set("messageExpression", om.valueToTree(this.getMessageExpression()));
}
if (this.getReason() != null) {
data.set("reason", om.valueToTree(this.getReason()));
}
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.ValidationV1Alpha1"));
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;
ValidationV1Alpha1.Jsii$Proxy that = (ValidationV1Alpha1.Jsii$Proxy) o;
if (!expression.equals(that.expression)) return false;
if (this.message != null ? !this.message.equals(that.message) : that.message != null) return false;
if (this.messageExpression != null ? !this.messageExpression.equals(that.messageExpression) : that.messageExpression != null) return false;
return this.reason != null ? this.reason.equals(that.reason) : that.reason == null;
}
@Override
public final int hashCode() {
int result = this.expression.hashCode();
result = 31 * result + (this.message != null ? this.message.hashCode() : 0);
result = 31 * result + (this.messageExpression != null ? this.messageExpression.hashCode() : 0);
result = 31 * result + (this.reason != null ? this.reason.hashCode() : 0);
return result;
}
}
}