Interface InlineRedactionPattern.Builder

All Superinterfaces:
Buildable, CopyableBuilder<InlineRedactionPattern.Builder,InlineRedactionPattern>, SdkBuilder<InlineRedactionPattern.Builder,InlineRedactionPattern>, SdkPojo
Enclosing class:
InlineRedactionPattern
@Mutable @NotThreadSafe public static interface InlineRedactionPattern.Builder extends SdkPojo, CopyableBuilder<InlineRedactionPattern.Builder,InlineRedactionPattern>

  • Method Details

    • builtInPatternId

      InlineRedactionPattern.Builder builtInPatternId(String builtInPatternId)

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

      Parameters:
      builtInPatternId - The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customPattern

      InlineRedactionPattern.Builder customPattern(CustomPattern customPattern)

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

      Parameters:
      customPattern - >The configuration for a custom pattern. Either a customPattern or builtInPatternId is required.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customPattern

      default InlineRedactionPattern.Builder customPattern(Consumer<CustomPattern.Builder> customPattern)

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

      This is a convenience method that creates an instance of the CustomPattern.Builder avoiding the need to create one manually via CustomPattern.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customPattern(CustomPattern).

      Parameters:
      customPattern - a consumer that will call methods on CustomPattern.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • redactionPlaceHolder

      InlineRedactionPattern.Builder redactionPlaceHolder(RedactionPlaceHolder redactionPlaceHolder)

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

      Parameters:
      redactionPlaceHolder - The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • redactionPlaceHolder

      default InlineRedactionPattern.Builder redactionPlaceHolder(Consumer<RedactionPlaceHolder.Builder> redactionPlaceHolder)

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

      This is a convenience method that creates an instance of the RedactionPlaceHolder.Builder avoiding the need to create one manually via RedactionPlaceHolder.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to redactionPlaceHolder(RedactionPlaceHolder).

      Parameters:
      redactionPlaceHolder - a consumer that will call methods on RedactionPlaceHolder.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • enforcedUrls

      InlineRedactionPattern.Builder enforcedUrls(Collection<String> enforcedUrls)

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

      Parameters:
      enforcedUrls - The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enforcedUrls

      InlineRedactionPattern.Builder enforcedUrls(String... enforcedUrls)

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

      Parameters:
      enforcedUrls - The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exemptUrls

      InlineRedactionPattern.Builder exemptUrls(Collection<String> exemptUrls)

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

      Parameters:
      exemptUrls - The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exemptUrls

      InlineRedactionPattern.Builder exemptUrls(String... exemptUrls)

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

      Parameters:
      exemptUrls - The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • confidenceLevel

      InlineRedactionPattern.Builder confidenceLevel(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.