Class ValidatingAdmissionPolicySpec

  • All Implemented Interfaces:
    com.marcnuri.yakc.model.Model

    public class ValidatingAdmissionPolicySpec
    extends java.lang.Object
    implements com.marcnuri.yakc.model.Model
    ValidatingAdmissionPolicySpec is the specification of the desired behavior of the AdmissionPolicy.
    • Constructor Detail

      • ValidatingAdmissionPolicySpec

        public ValidatingAdmissionPolicySpec()
    • Method Detail

      • getAuditAnnotations

        public java.util.List<AuditAnnotation> getAuditAnnotations()
        auditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request. validations and auditAnnotations may not both be empty; a least one of validations or auditAnnotations is required.
      • getFailurePolicy

        public java.lang.String getFailurePolicy()
        failurePolicy defines how to handle failures for the admission policy. Failures can occur from CEL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy definitions or bindings.


        A policy is invalid if spec.paramKind refers to a non-existent Kind. A binding is invalid if spec.paramRef.name refers to a non-existent resource.


        failurePolicy does not define how validations that evaluate to false are handled.


        When failurePolicy is set to Fail, ValidatingAdmissionPolicyBinding validationActions define how failures are enforced.


        Allowed values are Ignore or Fail. Defaults to Fail.

      • getMatchConditions

        public java.util.List<MatchCondition> getMatchConditions()
        MatchConditions is a list of conditions that must be met for a request to be validated. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed.


        If a parameter object is provided, it can be accessed via the `params` handle in the same manner as validation expressions.


        The exact matching logic is (in order):

        1. If ANY matchCondition evaluates to FALSE, the policy is skipped.

        2. If ALL matchConditions evaluate to TRUE, the policy is evaluated.

        3. If any matchCondition evaluates to an error (but none are FALSE):

        - If failurePolicy=Fail, reject the request

        - If failurePolicy=Ignore, the policy is skipped

      • getParamKind

        public ParamKind getParamKind()
      • getValidations

        public java.util.List<Validation> getValidations()
        Validations contain CEL expressions which is used to apply the validation. Validations and AuditAnnotations may not both be empty; a minimum of one Validations or AuditAnnotations is required.
      • getVariables

        public java.util.List<Variable> getVariables()
        Variables contain definitions of variables that can be used in composition of other expressions. Each variable is defined as a named CEL expression. The variables defined here will be available under `variables` in other expressions of the policy except MatchConditions because MatchConditions are evaluated before the rest of the policy.


        The expression of a variable can refer to other variables defined earlier in the list but not those after. Thus, Variables must be sorted by the order of first appearance and acyclic.

      • setAuditAnnotations

        public void setAuditAnnotations​(java.util.List<AuditAnnotation> auditAnnotations)
        auditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request. validations and auditAnnotations may not both be empty; a least one of validations or auditAnnotations is required.
      • setFailurePolicy

        public void setFailurePolicy​(java.lang.String failurePolicy)
        failurePolicy defines how to handle failures for the admission policy. Failures can occur from CEL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy definitions or bindings.


        A policy is invalid if spec.paramKind refers to a non-existent Kind. A binding is invalid if spec.paramRef.name refers to a non-existent resource.


        failurePolicy does not define how validations that evaluate to false are handled.


        When failurePolicy is set to Fail, ValidatingAdmissionPolicyBinding validationActions define how failures are enforced.


        Allowed values are Ignore or Fail. Defaults to Fail.

      • setMatchConditions

        public void setMatchConditions​(java.util.List<MatchCondition> matchConditions)
        MatchConditions is a list of conditions that must be met for a request to be validated. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed.


        If a parameter object is provided, it can be accessed via the `params` handle in the same manner as validation expressions.


        The exact matching logic is (in order):

        1. If ANY matchCondition evaluates to FALSE, the policy is skipped.

        2. If ALL matchConditions evaluate to TRUE, the policy is evaluated.

        3. If any matchCondition evaluates to an error (but none are FALSE):

        - If failurePolicy=Fail, reject the request

        - If failurePolicy=Ignore, the policy is skipped

      • setMatchConstraints

        public void setMatchConstraints​(MatchResources matchConstraints)
      • setParamKind

        public void setParamKind​(ParamKind paramKind)
      • setValidations

        public void setValidations​(java.util.List<Validation> validations)
        Validations contain CEL expressions which is used to apply the validation. Validations and AuditAnnotations may not both be empty; a minimum of one Validations or AuditAnnotations is required.
      • setVariables

        public void setVariables​(java.util.List<Variable> variables)
        Variables contain definitions of variables that can be used in composition of other expressions. Each variable is defined as a named CEL expression. The variables defined here will be available under `variables` in other expressions of the policy except MatchConditions because MatchConditions are evaluated before the rest of the policy.


        The expression of a variable can refer to other variables defined earlier in the list but not those after. Thus, Variables must be sorted by the order of first appearance and acyclic.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • canEqual

        protected boolean canEqual​(java.lang.Object other)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object