[
https://issues.apache.org/jira/browse/BEAM-9723?focusedWorklogId=459098&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-459098
]
ASF GitHub Bot logged work on BEAM-9723:
----------------------------------------
Author: ASF GitHub Bot
Created on: 15/Jul/20 06:55
Start Date: 15/Jul/20 06:55
Worklog Time Spent: 10m
Work Description: mwalenia commented on a change in pull request #11566:
URL: https://github.com/apache/beam/pull/11566#discussion_r454831991
##########
File path:
sdks/java/extensions/ml/src/main/java/org/apache/beam/sdk/extensions/ml/DLPDeidentifyText.java
##########
@@ -0,0 +1,282 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.sdk.extensions.ml;
+
+import com.google.auto.value.AutoValue;
+import com.google.cloud.dlp.v2.DlpServiceClient;
+import com.google.privacy.dlp.v2.ContentItem;
+import com.google.privacy.dlp.v2.DeidentifyConfig;
+import com.google.privacy.dlp.v2.DeidentifyContentRequest;
+import com.google.privacy.dlp.v2.DeidentifyContentResponse;
+import com.google.privacy.dlp.v2.FieldId;
+import com.google.privacy.dlp.v2.InspectConfig;
+import com.google.privacy.dlp.v2.ProjectName;
+import com.google.privacy.dlp.v2.Table;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.stream.Collectors;
+import javax.annotation.Nullable;
+import org.apache.beam.sdk.annotations.Experimental;
+import org.apache.beam.sdk.transforms.DoFn;
+import org.apache.beam.sdk.transforms.PTransform;
+import org.apache.beam.sdk.transforms.ParDo;
+import org.apache.beam.sdk.values.KV;
+import org.apache.beam.sdk.values.PCollection;
+import org.apache.beam.sdk.values.PCollectionView;
+
+/**
+ * A {@link PTransform} connecting to Cloud DLP
(https://cloud.google.com/dlp/docs/libraries) and
+ * deidentifying text according to provided settings. The transform supports
both columnar delimited
+ * input data (eg. CSV) and unstructured input.
+ *
+ * <p>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 side input, input is assumed to be unstructured.
+ *
+ * <p>Either deidentifyTemplateName (String) or deidentifyConfig {@link
DeidentifyConfig} need to be
+ * set. inspectTemplateName and inspectConfig ({@link InspectConfig} are
optional.
+ *
+ * <p>Batch size defines how big are batches sent to DLP at once in bytes.
+ *
+ * <p>The transform consumes {@link KV} of {@link String}s (assumed to be
filename as key and
+ * contents as value) and outputs {@link KV} of {@link String} (eg. filename)
and {@link
+ * DeidentifyContentResponse}, which will contain {@link Table} of results for
the user to consume.
+ */
+@Experimental
+@AutoValue
+public abstract class DLPDeidentifyText
+ extends PTransform<
+ PCollection<KV<String, String>>, PCollection<KV<String,
DeidentifyContentResponse>>> {
+
+ public static final Integer DLP_PAYLOAD_LIMIT_BYTES = 524000;
+
+ /** @return Template name for data inspection. */
+ @Nullable
+ public abstract String getInspectTemplateName();
+
+ /** @return Template name for data deidentification. */
+ @Nullable
+ public abstract String getDeidentifyTemplateName();
+
+ /**
+ * @return Configuration object for data inspection. If present, supersedes
the template settings.
+ */
+ @Nullable
+ public abstract InspectConfig getInspectConfig();
+
+ /** @return Configuration object for deidentification. If present,
supersedes the template. */
+ @Nullable
+ public abstract DeidentifyConfig getDeidentifyConfig();
+
+ /** @return List of column names if the input KV value is a delimited row. */
+ @Nullable
+ public abstract PCollectionView<List<String>> getHeaderColumns();
+
+ /** @return Delimiter to be used when splitting values from input strings
into columns. */
+ @Nullable
+ public abstract String getColumnDelimiter();
+
+ /** @return Size of input elements batch to be sent to Cloud DLP service in
one request. */
+ public abstract Integer getBatchSizeBytes();
+
+ /** @return ID of Google Cloud project to be used when deidentifying data. */
+ public abstract String getProjectId();
+
+ @AutoValue.Builder
+ public abstract static class Builder {
+ /** @param inspectTemplateName Template name for data inspection. */
+ public abstract Builder setInspectTemplateName(String inspectTemplateName);
+
+ /** @param headerColumns List of column names if the input KV value is a
delimited row. */
+ public abstract Builder setHeaderColumns(PCollectionView<List<String>>
headerColumns);
+
+ /**
+ * @param delimiter Delimiter to be used when splitting values from input
strings into columns.
+ */
+ public abstract Builder setColumnDelimiter(String delimiter);
+
+ /**
+ * @param batchSize Size of input elements batch to be sent to Cloud DLP
service in one request.
+ */
+ public abstract Builder setBatchSizeBytes(Integer batchSize);
+
+ /** @param projectId ID of Google Cloud project to be used when
deidentifying data. */
+ public abstract Builder setProjectId(String projectId);
+
+ /** @param deidentifyTemplateName Template name for data deidentification.
*/
+ public abstract Builder setDeidentifyTemplateName(String
deidentifyTemplateName);
+
+ /**
+ * @param inspectConfig Configuration object for data inspection. If
present, supersedes the
+ * template settings.
+ */
+ public abstract Builder setInspectConfig(InspectConfig inspectConfig);
+
+ /**
+ * @param deidentifyConfig Configuration object for data deidentification.
If present,
+ * supersedes the template settings.
+ */
+ public abstract Builder setDeidentifyConfig(DeidentifyConfig
deidentifyConfig);
+
+ abstract DLPDeidentifyText autoBuild();
+
+ public DLPDeidentifyText build() {
+ DLPDeidentifyText dlpDeidentifyText = autoBuild();
+ if (dlpDeidentifyText.getDeidentifyConfig() == null
+ && dlpDeidentifyText.getDeidentifyTemplateName() == null) {
+ throw new IllegalArgumentException(
+ "Either deidentifyConfig or deidentifyTemplateName need to be
set!");
+ }
+ if (dlpDeidentifyText.getBatchSizeBytes() > DLP_PAYLOAD_LIMIT_BYTES) {
+ throw new IllegalArgumentException(
+ String.format(
+ "Batch size is too large! It should be smaller or equal than
%d.",
+ DLP_PAYLOAD_LIMIT_BYTES));
+ }
+ if (dlpDeidentifyText.getColumnDelimiter() == null
+ && dlpDeidentifyText.getHeaderColumns() != null) {
+ throw new IllegalArgumentException(
+ "Column delimiter should be set if headers are present.");
+ }
+ if (dlpDeidentifyText.getHeaderColumns() == null
+ && dlpDeidentifyText.getColumnDelimiter() != null) {
+ throw new IllegalArgumentException(
+ "Column headers should be supplied when delimiter is present.");
+ }
+ return dlpDeidentifyText;
+ }
+ }
+
+ public static DLPDeidentifyText.Builder newBuilder() {
+ return new AutoValue_DLPDeidentifyText.Builder();
+ }
+
+ /**
+ * The transform converts the contents of input PCollection into {@link
Table.Row}s and then calls
+ * Cloud DLP service to perform the deidentification according to provided
settings.
+ *
+ * @param input input PCollection
+ * @return PCollection after transformations
+ */
+ @Override
+ public PCollection<KV<String, DeidentifyContentResponse>> expand(
+ PCollection<KV<String, String>> input) {
+ return input
+ .apply(ParDo.of(new MapStringToDlpRow(getColumnDelimiter())))
+ .apply("Batch Contents", ParDo.of(new
BatchRequestForDLP(getBatchSizeBytes())))
+ .apply(
+ "DLPDeidentify",
+ ParDo.of(
+ new DeidentifyText(
+ getProjectId(),
+ getInspectTemplateName(),
+ getDeidentifyTemplateName(),
+ getInspectConfig(),
+ getDeidentifyConfig(),
+ getHeaderColumns())));
+ }
+
Review comment:
Thanks for your keen eye, it must have slipped our minds during review
to check for the side input here. I'll try to get this fixed and ready for 2.23.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 459098)
Time Spent: 10h 10m (was: 10h)
> [Java] PTransform that connects to Cloud DLP deidentification service
> ---------------------------------------------------------------------
>
> Key: BEAM-9723
> URL: https://issues.apache.org/jira/browse/BEAM-9723
> Project: Beam
> Issue Type: Sub-task
> Components: io-java-gcp
> Reporter: Michał Walenia
> Assignee: Michał Walenia
> Priority: P2
> Labels: stale-assigned
> Fix For: 2.23.0
>
> Time Spent: 10h 10m
> Remaining Estimate: 0h
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
