Class DescribeRuleGroupSummaryResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallResponse
software.amazon.awssdk.services.networkfirewall.model.DescribeRuleGroupSummaryResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeRuleGroupSummaryResponse.Builder,DescribeRuleGroupSummaryResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeRuleGroupSummaryResponse extends NetworkFirewallResponse implements ToCopyableBuilder<DescribeRuleGroupSummaryResponse.Builder,DescribeRuleGroupSummaryResponse>

  • Method Details

    • ruleGroupName

      public final String ruleGroupName()

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

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

    • description

      public final String description()

      A description of the rule group.

      Returns:
      A description of the rule group.

    • summary

      public final Summary 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:
      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

    • toBuilder

      public DescribeRuleGroupSummaryResponse.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<DescribeRuleGroupSummaryResponse.Builder,DescribeRuleGroupSummaryResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeRuleGroupSummaryResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.