Class UriFragment

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

Inspect fragments of the request URI. You can specify the parts of the URI fragment to inspect and you can narrow the set of URI fragments to inspect by including or excluding specific keys.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

Example JSON: "UriFragment": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }

See Also:

  • Method Details

    • fallbackBehavior

      public final FallbackBehavior fallbackBehavior()

      What WAF should do if it fails to completely parse the JSON body. The options are the following:

      • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

      • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

      • NO_MATCH - Treat the web request as not matching the rule statement.

      If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

      Example JSON: { "UriFragment": { "FallbackBehavior": "MATCH"} }

      WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.

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

      Returns:
      What WAF should do if it fails to completely parse the JSON body. The options are the following:

      • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

      • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

      • NO_MATCH - Treat the web request as not matching the rule statement.

      If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

      Example JSON: { "UriFragment": { "FallbackBehavior": "MATCH"} }

      WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.

      See Also:

    • fallbackBehaviorAsString

      public final String fallbackBehaviorAsString()

      What WAF should do if it fails to completely parse the JSON body. The options are the following:

      • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

      • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

      • NO_MATCH - Treat the web request as not matching the rule statement.

      If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

      Example JSON: { "UriFragment": { "FallbackBehavior": "MATCH"} }

      WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.

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

      Returns:
      What WAF should do if it fails to completely parse the JSON body. The options are the following:

      • EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

      • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

      • NO_MATCH - Treat the web request as not matching the rule statement.

      If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

      Example JSON: { "UriFragment": { "FallbackBehavior": "MATCH"} }

      WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.

      See Also:

    • toBuilder

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

    • builder

      public static UriFragment.Builder builder()

    • serializableBuilderClass

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