Class InlineRedactionPattern

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

The set of patterns that determine the data types redacted in session.

See Also:

  • Method Details

    • builtInPatternId

      public final String builtInPatternId()

      The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required.

      Returns:
      The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required.

    • customPattern

      public final CustomPattern customPattern()

      >The configuration for a custom pattern. Either a customPattern or builtInPatternId is required.

      Returns:
      >The configuration for a custom pattern. Either a customPattern or builtInPatternId is required.

    • redactionPlaceHolder

      public final RedactionPlaceHolder redactionPlaceHolder()

      The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.

      Returns:
      The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.

    • hasEnforcedUrls

      public final boolean hasEnforcedUrls()
      For responses, this returns true if the service returned a value for the EnforcedUrls 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.

    • enforcedUrls

      public final List<String> enforcedUrls()

      The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration.

      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 hasEnforcedUrls() method.

      Returns:
      The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration.

    • hasExemptUrls

      public final boolean hasExemptUrls()
      For responses, this returns true if the service returned a value for the ExemptUrls 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.

    • exemptUrls

      public final List<String> exemptUrls()

      The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern.

      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 hasExemptUrls() method.

      Returns:
      The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern.

    • confidenceLevel

      public final Integer confidenceLevel()

      The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level.

      Returns:
      The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level.

    • toBuilder

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

    • builder

      public static InlineRedactionPattern.Builder builder()

    • serializableBuilderClass

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