Class AutomatedReasoningPolicyBuildResultAssets

java.lang.Object
software.amazon.awssdk.services.bedrock.model.AutomatedReasoningPolicyBuildResultAssets
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AutomatedReasoningPolicyBuildResultAssets.Builder,AutomatedReasoningPolicyBuildResultAssets>
@Generated("software.amazon.awssdk:codegen") public final class AutomatedReasoningPolicyBuildResultAssets extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AutomatedReasoningPolicyBuildResultAssets.Builder,AutomatedReasoningPolicyBuildResultAssets>

Contains the various assets generated during a policy build workflow, including logs, quality reports, test cases, and the final policy definition.

See Also:

  • Method Details

    • policyDefinition

      public final AutomatedReasoningPolicyDefinition policyDefinition()

      The complete policy definition generated by the build workflow, containing all rules, variables, and custom types extracted from the source documents.

      Returns:
      The complete policy definition generated by the build workflow, containing all rules, variables, and custom types extracted from the source documents.

    • qualityReport

      public final AutomatedReasoningPolicyDefinitionQualityReport qualityReport()

      A comprehensive report analyzing the quality of the generated policy, including metrics about rule coverage, potential conflicts, and unused elements.

      Returns:
      A comprehensive report analyzing the quality of the generated policy, including metrics about rule coverage, potential conflicts, and unused elements.

    • buildLog

      public final AutomatedReasoningPolicyBuildLog buildLog()

      The complete build log containing detailed information about each step in the policy generation process.

      Returns:
      The complete build log containing detailed information about each step in the policy generation process.

    • generatedTestCases

      public final AutomatedReasoningPolicyGeneratedTestCases generatedTestCases()

      A comprehensive test suite generated by the build workflow, providing validation capabilities for automated reasoning policies.

      Returns:
      A comprehensive test suite generated by the build workflow, providing validation capabilities for automated reasoning policies.

    • policyScenarios

      public final AutomatedReasoningPolicyScenarios policyScenarios()

      An entity encompassing all the policy scenarios generated by the build workflow, which can be used to validate an Automated Reasoning policy.

      Returns:
      An entity encompassing all the policy scenarios generated by the build workflow, which can be used to validate an Automated Reasoning policy.

    • assetManifest

      public final AutomatedReasoningPolicyBuildResultAssetManifest assetManifest()

      A manifest listing all available artifacts produced by the build workflow. This provides a catalog of all assets that can be retrieved, including their types, names, and identifiers.

      Returns:
      A manifest listing all available artifacts produced by the build workflow. This provides a catalog of all assets that can be retrieved, including their types, names, and identifiers.

    • document

      public final AutomatedReasoningPolicySourceDocument document()

      A source document that was used as input during the build workflow. This allows you to retrieve the original documents that were processed to generate the policy.

      Returns:
      A source document that was used as input during the build workflow. This allows you to retrieve the original documents that were processed to generate the policy.

    • fidelityReport

      public final AutomatedReasoningPolicyFidelityReport fidelityReport()

      A comprehensive fidelity report that measures how accurately the generated policy represents the source documents. The report includes coverage and accuracy scores, along with detailed grounding information for rules and variables.

      Returns:
      A comprehensive fidelity report that measures how accurately the generated policy represents the source documents. The report includes coverage and accuracy scores, along with detailed grounding information for rules and variables.

    • toBuilder

      public AutomatedReasoningPolicyBuildResultAssets.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AutomatedReasoningPolicyBuildResultAssets.Builder,AutomatedReasoningPolicyBuildResultAssets>
      Returns:
      a builder for type T

    • builder

      public static AutomatedReasoningPolicyBuildResultAssets.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AutomatedReasoningPolicyBuildResultAssets.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • fromPolicyDefinition

      public static AutomatedReasoningPolicyBuildResultAssets fromPolicyDefinition(AutomatedReasoningPolicyDefinition policyDefinition)
      Create an instance of this class with policyDefinition() initialized to the given value.

      The complete policy definition generated by the build workflow, containing all rules, variables, and custom types extracted from the source documents.

      Parameters:
      policyDefinition - The complete policy definition generated by the build workflow, containing all rules, variables, and custom types extracted from the source documents.

    • fromPolicyDefinition

      public static AutomatedReasoningPolicyBuildResultAssets fromPolicyDefinition(Consumer<AutomatedReasoningPolicyDefinition.Builder> policyDefinition)
      Create an instance of this class with policyDefinition() initialized to the given value.

      The complete policy definition generated by the build workflow, containing all rules, variables, and custom types extracted from the source documents.

      Parameters:
      policyDefinition - The complete policy definition generated by the build workflow, containing all rules, variables, and custom types extracted from the source documents.

    • fromQualityReport

      public static AutomatedReasoningPolicyBuildResultAssets fromQualityReport(AutomatedReasoningPolicyDefinitionQualityReport qualityReport)
      Create an instance of this class with qualityReport() initialized to the given value.

      A comprehensive report analyzing the quality of the generated policy, including metrics about rule coverage, potential conflicts, and unused elements.

      Parameters:
      qualityReport - A comprehensive report analyzing the quality of the generated policy, including metrics about rule coverage, potential conflicts, and unused elements.

    • fromQualityReport

      public static AutomatedReasoningPolicyBuildResultAssets fromQualityReport(Consumer<AutomatedReasoningPolicyDefinitionQualityReport.Builder> qualityReport)
      Create an instance of this class with qualityReport() initialized to the given value.

      A comprehensive report analyzing the quality of the generated policy, including metrics about rule coverage, potential conflicts, and unused elements.

      Parameters:
      qualityReport - A comprehensive report analyzing the quality of the generated policy, including metrics about rule coverage, potential conflicts, and unused elements.

    • fromBuildLog

      public static AutomatedReasoningPolicyBuildResultAssets fromBuildLog(AutomatedReasoningPolicyBuildLog buildLog)
      Create an instance of this class with buildLog() initialized to the given value.

      The complete build log containing detailed information about each step in the policy generation process.

      Parameters:
      buildLog - The complete build log containing detailed information about each step in the policy generation process.

    • fromBuildLog

      public static AutomatedReasoningPolicyBuildResultAssets fromBuildLog(Consumer<AutomatedReasoningPolicyBuildLog.Builder> buildLog)
      Create an instance of this class with buildLog() initialized to the given value.

      The complete build log containing detailed information about each step in the policy generation process.

      Parameters:
      buildLog - The complete build log containing detailed information about each step in the policy generation process.

    • fromGeneratedTestCases

      public static AutomatedReasoningPolicyBuildResultAssets fromGeneratedTestCases(AutomatedReasoningPolicyGeneratedTestCases generatedTestCases)
      Create an instance of this class with generatedTestCases() initialized to the given value.

      A comprehensive test suite generated by the build workflow, providing validation capabilities for automated reasoning policies.

      Parameters:
      generatedTestCases - A comprehensive test suite generated by the build workflow, providing validation capabilities for automated reasoning policies.

    • fromGeneratedTestCases

      public static AutomatedReasoningPolicyBuildResultAssets fromGeneratedTestCases(Consumer<AutomatedReasoningPolicyGeneratedTestCases.Builder> generatedTestCases)
      Create an instance of this class with generatedTestCases() initialized to the given value.

      A comprehensive test suite generated by the build workflow, providing validation capabilities for automated reasoning policies.

      Parameters:
      generatedTestCases - A comprehensive test suite generated by the build workflow, providing validation capabilities for automated reasoning policies.

    • fromPolicyScenarios

      public static AutomatedReasoningPolicyBuildResultAssets fromPolicyScenarios(AutomatedReasoningPolicyScenarios policyScenarios)
      Create an instance of this class with policyScenarios() initialized to the given value.

      An entity encompassing all the policy scenarios generated by the build workflow, which can be used to validate an Automated Reasoning policy.

      Parameters:
      policyScenarios - An entity encompassing all the policy scenarios generated by the build workflow, which can be used to validate an Automated Reasoning policy.

    • fromPolicyScenarios

      public static AutomatedReasoningPolicyBuildResultAssets fromPolicyScenarios(Consumer<AutomatedReasoningPolicyScenarios.Builder> policyScenarios)
      Create an instance of this class with policyScenarios() initialized to the given value.

      An entity encompassing all the policy scenarios generated by the build workflow, which can be used to validate an Automated Reasoning policy.

      Parameters:
      policyScenarios - An entity encompassing all the policy scenarios generated by the build workflow, which can be used to validate an Automated Reasoning policy.

    • fromAssetManifest

      public static AutomatedReasoningPolicyBuildResultAssets fromAssetManifest(AutomatedReasoningPolicyBuildResultAssetManifest assetManifest)
      Create an instance of this class with assetManifest() initialized to the given value.

      A manifest listing all available artifacts produced by the build workflow. This provides a catalog of all assets that can be retrieved, including their types, names, and identifiers.

      Parameters:
      assetManifest - A manifest listing all available artifacts produced by the build workflow. This provides a catalog of all assets that can be retrieved, including their types, names, and identifiers.

    • fromAssetManifest

      public static AutomatedReasoningPolicyBuildResultAssets fromAssetManifest(Consumer<AutomatedReasoningPolicyBuildResultAssetManifest.Builder> assetManifest)
      Create an instance of this class with assetManifest() initialized to the given value.

      A manifest listing all available artifacts produced by the build workflow. This provides a catalog of all assets that can be retrieved, including their types, names, and identifiers.

      Parameters:
      assetManifest - A manifest listing all available artifacts produced by the build workflow. This provides a catalog of all assets that can be retrieved, including their types, names, and identifiers.

    • fromDocument

      public static AutomatedReasoningPolicyBuildResultAssets fromDocument(AutomatedReasoningPolicySourceDocument document)
      Create an instance of this class with document() initialized to the given value.

      A source document that was used as input during the build workflow. This allows you to retrieve the original documents that were processed to generate the policy.

      Parameters:
      document - A source document that was used as input during the build workflow. This allows you to retrieve the original documents that were processed to generate the policy.

    • fromDocument

      public static AutomatedReasoningPolicyBuildResultAssets fromDocument(Consumer<AutomatedReasoningPolicySourceDocument.Builder> document)
      Create an instance of this class with document() initialized to the given value.

      A source document that was used as input during the build workflow. This allows you to retrieve the original documents that were processed to generate the policy.

      Parameters:
      document - A source document that was used as input during the build workflow. This allows you to retrieve the original documents that were processed to generate the policy.

    • fromFidelityReport

      public static AutomatedReasoningPolicyBuildResultAssets fromFidelityReport(AutomatedReasoningPolicyFidelityReport fidelityReport)
      Create an instance of this class with fidelityReport() initialized to the given value.

      A comprehensive fidelity report that measures how accurately the generated policy represents the source documents. The report includes coverage and accuracy scores, along with detailed grounding information for rules and variables.

      Parameters:
      fidelityReport - A comprehensive fidelity report that measures how accurately the generated policy represents the source documents. The report includes coverage and accuracy scores, along with detailed grounding information for rules and variables.

    • fromFidelityReport

      public static AutomatedReasoningPolicyBuildResultAssets fromFidelityReport(Consumer<AutomatedReasoningPolicyFidelityReport.Builder> fidelityReport)
      Create an instance of this class with fidelityReport() initialized to the given value.

      A comprehensive fidelity report that measures how accurately the generated policy represents the source documents. The report includes coverage and accuracy scores, along with detailed grounding information for rules and variables.

      Parameters:
      fidelityReport - A comprehensive fidelity report that measures how accurately the generated policy represents the source documents. The report includes coverage and accuracy scores, along with detailed grounding information for rules and variables.

    • type

      public AutomatedReasoningPolicyBuildResultAssets.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be AutomatedReasoningPolicyBuildResultAssets.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be AutomatedReasoningPolicyBuildResultAssets.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.