Package software.amazon.awssdk.services.workspacesweb.model

Class InlineRedactionPattern

    • Method Detail

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

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

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

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

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

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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