Interface AutomatedReasoningPolicyRuleReport.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AutomatedReasoningPolicyRuleReport.Builder,AutomatedReasoningPolicyRuleReport>, SdkBuilder<AutomatedReasoningPolicyRuleReport.Builder,AutomatedReasoningPolicyRuleReport>, SdkPojo

Enclosing class:

AutomatedReasoningPolicyRuleReport

@Mutable
@NotThreadSafe
public static interface AutomatedReasoningPolicyRuleReport.Builder
extends SdkPojo, CopyableBuilder<AutomatedReasoningPolicyRuleReport.Builder,AutomatedReasoningPolicyRuleReport>

Method Summary

Modifier and Type	Method	Description
AutomatedReasoningPolicyRuleReport.Builder	accuracyJustification(String accuracyJustification)	A textual explanation of the accuracy score, describing why the rule received this particular accuracy rating.
AutomatedReasoningPolicyRuleReport.Builder	accuracyScore(Double accuracyScore)	A score from 0.0 to 1.0 indicating how accurately this rule represents the source material.
AutomatedReasoningPolicyRuleReport.Builder	groundingJustifications(String... groundingJustifications)	Explanations describing how the source statements support and justify this specific rule.
AutomatedReasoningPolicyRuleReport.Builder	groundingJustifications(Collection<String> groundingJustifications)	Explanations describing how the source statements support and justify this specific rule.
AutomatedReasoningPolicyRuleReport.Builder	groundingStatements(Collection<AutomatedReasoningPolicyStatementReference> groundingStatements)	References to statements from the source documents that provide the basis or justification for this rule.
AutomatedReasoningPolicyRuleReport.Builder	groundingStatements(Consumer<AutomatedReasoningPolicyStatementReference.Builder>... groundingStatements)	References to statements from the source documents that provide the basis or justification for this rule.
AutomatedReasoningPolicyRuleReport.Builder	groundingStatements(AutomatedReasoningPolicyStatementReference... groundingStatements)	References to statements from the source documents that provide the basis or justification for this rule.
AutomatedReasoningPolicyRuleReport.Builder	rule(String rule)	The identifier of the policy rule being analyzed in this report.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

rule

AutomatedReasoningPolicyRuleReport.Builder rule(String rule)

The identifier of the policy rule being analyzed in this report.

Parameters:

rule - The identifier of the policy rule being analyzed in this report.

Returns:

Returns a reference to this object so that method calls can be chained together.

groundingStatements

AutomatedReasoningPolicyRuleReport.Builder groundingStatements(Collection<AutomatedReasoningPolicyStatementReference> groundingStatements)

References to statements from the source documents that provide the basis or justification for this rule.

Parameters:

groundingStatements - References to statements from the source documents that provide the basis or justification for this rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

groundingStatements

AutomatedReasoningPolicyRuleReport.Builder groundingStatements(AutomatedReasoningPolicyStatementReference... groundingStatements)

References to statements from the source documents that provide the basis or justification for this rule.

Parameters:

groundingStatements - References to statements from the source documents that provide the basis or justification for this rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

groundingStatements

AutomatedReasoningPolicyRuleReport.Builder groundingStatements(Consumer<AutomatedReasoningPolicyStatementReference.Builder>... groundingStatements)

References to statements from the source documents that provide the basis or justification for this rule.

This is a convenience method that creates an instance of the AutomatedReasoningPolicyStatementReference.Builder avoiding the need to create one manually via AutomatedReasoningPolicyStatementReference.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to groundingStatements(List<AutomatedReasoningPolicyStatementReference>).

Parameters:

groundingStatements - a consumer that will call methods on AutomatedReasoningPolicyStatementReference.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• groundingStatements(java.util.Collection<AutomatedReasoningPolicyStatementReference>)

groundingJustifications

AutomatedReasoningPolicyRuleReport.Builder groundingJustifications(Collection<String> groundingJustifications)

Explanations describing how the source statements support and justify this specific rule.

Parameters:

groundingJustifications - Explanations describing how the source statements support and justify this specific rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

groundingJustifications

AutomatedReasoningPolicyRuleReport.Builder groundingJustifications(String... groundingJustifications)

Explanations describing how the source statements support and justify this specific rule.

Parameters:

groundingJustifications - Explanations describing how the source statements support and justify this specific rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

accuracyScore

AutomatedReasoningPolicyRuleReport.Builder accuracyScore(Double accuracyScore)

A score from 0.0 to 1.0 indicating how accurately this rule represents the source material.

Parameters:

accuracyScore - A score from 0.0 to 1.0 indicating how accurately this rule represents the source material.

Returns:

Returns a reference to this object so that method calls can be chained together.

accuracyJustification

AutomatedReasoningPolicyRuleReport.Builder accuracyJustification(String accuracyJustification)

A textual explanation of the accuracy score, describing why the rule received this particular accuracy rating.

Parameters:

accuracyJustification - A textual explanation of the accuracy score, describing why the rule received this particular accuracy rating.

Returns:

Returns a reference to this object so that method calls can be chained together.