Class RuleSummary

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

Summary information about a rule.

See Also:

  • Method Details

    • ruleId

      public final String ruleId()

      The service-generated id of the rule.

      Returns:
      The service-generated id of the rule.

    • ruleArn

      public final String ruleArn()

      The Amazon Resource Name (ARN) of the rule.

      Returns:
      The Amazon Resource Name (ARN) of the rule.

    • ruleName

      public final String ruleName()

      The name of the rule.

      Returns:
      The name of the rule.

    • firewallType

      public final RuleFirewallType firewallType()

      The firewall type associated with the resource.

      If the service returns an enum value that is not available in the current SDK version, firewallType will return RuleFirewallType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from firewallTypeAsString().

      Returns:
      The firewall type associated with the resource.
      See Also:

    • firewallTypeAsString

      public final String firewallTypeAsString()

      The firewall type associated with the resource.

      If the service returns an enum value that is not available in the current SDK version, firewallType will return RuleFirewallType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from firewallTypeAsString().

      Returns:
      The firewall type associated with the resource.
      See Also:

    • ruleType

      public final RuleType ruleType()

      The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.

      If the service returns an enum value that is not available in the current SDK version, ruleType will return RuleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ruleTypeAsString().

      Returns:
      The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
      See Also:

    • ruleTypeAsString

      public final String ruleTypeAsString()

      The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.

      If the service returns an enum value that is not available in the current SDK version, ruleType will return RuleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ruleTypeAsString().

      Returns:
      The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
      See Also:

    • status

      public final EntityStatus status()

      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).

      If the service returns an enum value that is not available in the current SDK version, status will return EntityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).

      If the service returns an enum value that is not available in the current SDK version, status will return EntityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
      See Also:

    • version

      public final String version()

      The version of the resource.

      Returns:
      The version of the resource.

    • hasPublishedVersion

      public final Boolean hasPublishedVersion()

      Specifies whether a published version of the resource exists.

      Returns:
      Specifies whether a published version of the resource exists.

    • updatedAt

      public final Instant updatedAt()

      The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.

      Returns:
      The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.

    • toBuilder

      public RuleSummary.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<RuleSummary.Builder,RuleSummary>
      Returns:
      a builder for type T

    • builder

      public static RuleSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RuleSummary.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)

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