Class ProxyRule

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

Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).

See Also:

  • Method Details

    • proxyRuleName

      public final String proxyRuleName()

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

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

    • description

      public final String description()

      A description of the proxy rule.

      Returns:
      A description of the proxy rule.

    • action

      public final ProxyRulePhaseAction action()

      Action to take.

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

      Returns:
      Action to take.
      See Also:

    • actionAsString

      public final String actionAsString()

      Action to take.

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

      Returns:
      Action to take.
      See Also:

    • hasConditions

      public final boolean hasConditions()
      For responses, this returns true if the service returned a value for the Conditions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • conditions

      public final List<ProxyRuleCondition> conditions()

      Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConditions() method.

      Returns:
      Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

    • toBuilder

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

    • builder

      public static ProxyRule.Builder builder()

    • serializableBuilderClass

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