Class NetworkTrafficRule

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

A rule that controls network traffic during penetration testing by allowing or denying traffic to specific URL patterns.

See Also:

  • Method Details

    • effect

      public final NetworkTrafficRuleEffect effect()

      The effect of the rule. Valid values are ALLOW and DENY.

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

      Returns:
      The effect of the rule. Valid values are ALLOW and DENY.
      See Also:

    • effectAsString

      public final String effectAsString()

      The effect of the rule. Valid values are ALLOW and DENY.

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

      Returns:
      The effect of the rule. Valid values are ALLOW and DENY.
      See Also:

    • pattern

      public final String pattern()

      The URL pattern to match for the rule.

      Returns:
      The URL pattern to match for the rule.

    • networkTrafficRuleType

      public final NetworkTrafficRuleType networkTrafficRuleType()

      The type of the network traffic rule. Currently, only URL is supported.

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

      Returns:
      The type of the network traffic rule. Currently, only URL is supported.
      See Also:

    • networkTrafficRuleTypeAsString

      public final String networkTrafficRuleTypeAsString()

      The type of the network traffic rule. Currently, only URL is supported.

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

      Returns:
      The type of the network traffic rule. Currently, only URL is supported.
      See Also:

    • toBuilder

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

    • builder

      public static NetworkTrafficRule.Builder builder()

    • serializableBuilderClass

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