Interface DescribeRuleGroupSummaryResponse.Builder

  • Method Details

    • ruleGroupName

      DescribeRuleGroupSummaryResponse.Builder ruleGroupName(String ruleGroupName)

      The descriptive name of the rule group. You can't change the name of a rule group after you create it.

      Parameters:
      ruleGroupName - The descriptive name of the rule group. You can't change the name of a rule group after you create it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      A description of the rule group.

      Parameters:
      description - A description of the rule group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • summary

      A complex type that contains rule information based on the rule group's configured summary settings. The content varies depending on the fields that you specified to extract in your SummaryConfiguration. When you haven't configured any summary settings, this returns an empty array. The response might include:

      • Rule identifiers

      • Rule descriptions

      • Any metadata fields that you specified in your SummaryConfiguration

      Parameters:
      summary - A complex type that contains rule information based on the rule group's configured summary settings. The content varies depending on the fields that you specified to extract in your SummaryConfiguration. When you haven't configured any summary settings, this returns an empty array. The response might include:

      • Rule identifiers

      • Rule descriptions

      • Any metadata fields that you specified in your SummaryConfiguration

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

      A complex type that contains rule information based on the rule group's configured summary settings. The content varies depending on the fields that you specified to extract in your SummaryConfiguration. When you haven't configured any summary settings, this returns an empty array. The response might include:

      • Rule identifiers

      • Rule descriptions

      • Any metadata fields that you specified in your SummaryConfiguration

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to summary(Summary).

      Parameters:
      summary - a consumer that will call methods on Summary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: