Record Class CloudForgeSynthesizer.ComplianceCheckResult

java.lang.Object
java.lang.Record
com.cloudforgeci.api.deploy.CloudForgeSynthesizer.ComplianceCheckResult
Record Components:
error - non-null only when app.synth() itself failed to complete (e.g. an "always load" cross-framework validator that hard-blocks regardless of complianceMode — not every validator in this codebase honors ADVISORY the way the framework-specific ones do). frameworkFindings may still be partially populated in that case (whatever ran before the failing validator), but nagFindings is always empty, since cdk-nag's own report files never get written unless synthesis actually finished.
Enclosing class:
CloudForgeSynthesizer
public static record CloudForgeSynthesizer.ComplianceCheckResult(String stackName, List<NagReportReader.ComplianceFinding> nagFindings, List<NagReportReader.ComplianceFinding> frameworkFindings, String error) extends Record
CloudForgeSynthesizer.synthesizeAdvisoryDryRun(DeploymentConfig, Path)'s result — every finding cdk-nag and the requested FrameworkRules implementations produced, with nothing filtered out the way CloudForgeSynthesizer.synthesize(DeploymentConfig, Path)'s own ENFORCE-mode check only reads error-level cdk-nag lines.

  • Constructor Details

    • ComplianceCheckResult

      public ComplianceCheckResult(String stackName, List<NagReportReader.ComplianceFinding> nagFindings, List<NagReportReader.ComplianceFinding> frameworkFindings, String error)
      Creates an instance of a ComplianceCheckResult record class.
      Parameters:
      stackName - the value for the stackName record component
      nagFindings - the value for the nagFindings record component
      frameworkFindings - the value for the frameworkFindings record component
      error - the value for the error record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • stackName

      public String stackName()
      Returns the value of the stackName record component.
      Returns:
      the value of the stackName record component

    • nagFindings

      public List<NagReportReader.ComplianceFinding> nagFindings()
      Returns the value of the nagFindings record component.
      Returns:
      the value of the nagFindings record component

    • frameworkFindings

      public List<NagReportReader.ComplianceFinding> frameworkFindings()
      Returns the value of the frameworkFindings record component.
      Returns:
      the value of the frameworkFindings record component

    • error

      public String error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component