Package org.apache.beam.sdk.extensions.ml

Class DLPInspectText

java.lang.Object
org.apache.beam.sdk.transforms.PTransform<PCollection<KV<String,String>>,PCollection<KV<String,com.google.privacy.dlp.v2.InspectContentResponse>>>
org.apache.beam.sdk.extensions.ml.DLPInspectText
All Implemented Interfaces:
Serializable, HasDisplayData
public abstract class DLPInspectText extends PTransform<PCollection<KV<String,String>>,PCollection<KV<String,com.google.privacy.dlp.v2.InspectContentResponse>>>
A PTransform connecting to Cloud DLP (https://cloud.google.com/dlp/docs/libraries) and inspecting text for identifying data according to provided settings. The transform supports both delimited columnar input data (eg. CSV) and unstructured input.

If the headerColumns property is set and a sideinput with table headers is added to the PTransform, delimiter also should be set, else the results will be incorrect. If headerColumns is neither set nor passed as sideinput, input is assumed to be unstructured.

Batch size defines how big are batches sent to DLP at once in bytes.

The transform consumes KV of Strings (assumed to be filename as key and contents as value) and outputs KV of String (eg. filename) and InspectContentResponse, which will contain a list of InspectResult for the user to consume.

Either inspectTemplateName (String) or inspectConfig InspectConfig need to be set.

Batch size defines how big are batches sent to DLP at once in bytes.

See Also:

  • Field Details

    • DLP_PAYLOAD_LIMIT_BYTES

      public static final Integer DLP_PAYLOAD_LIMIT_BYTES

  • Constructor Details

    • DLPInspectText

      public DLPInspectText()

  • Method Details

    • getInspectTemplateName

      public abstract @Nullable String getInspectTemplateName()
      Returns:
      Template name for data inspection.

    • getInspectConfig

      public abstract @Nullable com.google.privacy.dlp.v2.InspectConfig getInspectConfig()
      Returns:
      Configuration object for data inspection. If present, supersedes the template settings.

    • getBatchSizeBytes

      public abstract Integer getBatchSizeBytes()
      Returns:
      Size of input elements batch to be sent to Cloud DLP service in one request.

    • getProjectId

      public abstract String getProjectId()
      Returns:
      ID of Google Cloud project to be used when deidentifying data.

    • getColumnDelimiter

      public abstract @Nullable String getColumnDelimiter()
      Returns:
      Delimiter to be used when splitting values from input strings into columns.

    • getHeaderColumns

      public abstract @Nullable PCollectionView<List<String>> getHeaderColumns()
      Returns:
      List of column names if the input KV value is a delimited row.

    • newBuilder

      public static DLPInspectText.Builder newBuilder()

    • expand

      public PCollection<KV<String,com.google.privacy.dlp.v2.InspectContentResponse>> expand(PCollection<KV<String,String>> input)
      The transform converts the contents of input PCollection into Table.Rows and then calls Cloud DLP service to perform the data inspection according to provided settings.
      Specified by:
      expand in class PTransform<PCollection<KV<String,String>>,PCollection<KV<String,com.google.privacy.dlp.v2.InspectContentResponse>>>
      Parameters:
      input - input PCollection
      Returns:
      PCollection after transformations